mailup 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2954259506053f8acefde3cf2d6d9bfff76ffdc
-  data.tar.gz: b506fb4efd45263932edd677e6f155c761000401
+  metadata.gz: 022ed54407b8cdb93c017bf25f3fcd002395230d
+  data.tar.gz: ae2e4c7aa56dd02173851fc7f6ce25e1e76c001d
 SHA512:
-  metadata.gz: b9463e8d8a5e7de85161f34ca75280b60ea46e3b1b72a81b994224147be3d7f0c20de7b4c563e7fc04659dd25979c4adb93f7dcd804ef9c54b51fb227e37560b
-  data.tar.gz: 5d59ab00556ffbc4a98da5da3fc57b4b8e9333f1113266e078f0f52b6a33bba782a8aea12292ecf1a5af29eab918c534ceef02a4f14a8c70b7f43334a66cc25e
+  metadata.gz: d0ecb6b846da02d4a1dcae714c07d93707db6598818100bcbb3ae0253561c618ad9bcb47542d7ffe317e75da03639f9ecc6623d25c77e515746c8aa527590690
+  data.tar.gz: f5b33ac0f05b5ea2dfee10b498e9b4dda0b56ad4363d84043a15261ce29d2c5677ebe54e4c03cf27331050ee0284fdb4bcc7a6cffd85c2154d14ad785174223c

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - jruby
+  - jruby

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 MailUp S.p.A
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -2,6 +2,10 @@
 
 A Ruby gem for interacting with the MailUp REST API.
 
+[![Build Status](https://travis-ci.org/mailup/mailup-ruby.svg)](https://travis-ci.org/mailup/mailup-ruby)
+[![Coverage Status](https://img.shields.io/coveralls/mailup/mailup-ruby.svg)](https://coveralls.io/r/mailup/mailup-ruby)
+[![Code Climate](https://codeclimate.com/github/mailup/mailup-ruby/badges/gpa.svg)](https://codeclimate.com/github/mailup/mailup-ruby)
+[![Dependency Status](https://gemnasium.com/mailup/mailup-ruby.svg)](https://gemnasium.com/mailup/mailup-ruby)
 ## Installation
 
 Install the gem directly:
@@ -37,7 +41,7 @@ credentials = {
   }
 }
 
-mailup = MailUp::Api.new(credentials)
+mailup = MailUp::API.new(credentials)
 ```
 
 ### Console Methods
@@ -76,4 +80,4 @@ views_count = mailup.stats.message(17).views_count
 
 fields = mailup.stats.recipient(5).fields
 # => {"IsPaginated"=>true, "Items"=>[{"Description"=>"AllOrderedProductIDs", "Id"=>26}, ...], ...}
-```
+```

data/Rakefile

@@ -4,4 +4,4 @@ require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new('spec')
 
 # If you want to make this the default task
-#task default: :spec
+task default: :spec

data/lib/mailup.rb

@@ -1,5 +1,8 @@
 require 'oauth2'
 require 'multi_json'
+require "net/https"
+require 'json'
+require "uri"
 
 require 'mailup/version'
 require 'mailup/errors'
@@ -19,7 +22,7 @@ require 'mailup/stats/recipient'
 
 module MailUp
   class API
-    attr_accessor :access_token, :debug, :host, :path
+    attr_accessor :access_token, :debug, :host, :path, :credentials
 
     # Initialize a new (thread-safe) API instance.
     #
@@ -49,6 +52,7 @@ module MailUp
       @debug = debug
       @host = 'https://services.mailup.com'
       @path = ''
+      @credentials = credentials
 
       # Validate the credentials
       raise Error.new, 'MailUp credentials missing' if credentials.nil? or !credentials.is_a?(Hash)
@@ -103,6 +107,25 @@ module MailUp
       end
     end
 
+    # Make a request with for Provisioning Calls.
+    #
+    # @param [Symbol] verb the HTTP request method
+    # @param [String] path the HTTP URL path of the request
+    # @param [Hash] opts the options to make the request with
+    #
+    def provisioning_request(path, body = nil) # :nodoc:
+      uri = URI.parse(@host)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+      req = Net::HTTP::Post.new(path, initheader = {'Content-Type' =>'application/json'})
+      req.basic_auth @credentials[:client_id], @credentials[:client_secret]
+      req.body = body.to_json
+
+      http.request(req).body.to_json
+    end
+
     # Make a GET request with the Access Token
     # @see #request
     #

data/lib/mailup/console/base.rb

@@ -83,7 +83,7 @@ module MailUp
       #   list = mailup.console.list(2)
       #
       def public
-        Public.new @api
+        Public::Base.new @api
       end
 
       # Create a recipient object

data/lib/mailup/console/email.rb

@@ -4,11 +4,11 @@ module MailUp
       attr_accessor :api
 
       def initialize(api)
-          @api = api
+        @api = api
       end
 
       # Send single email message to specified recipient.
-      # 
+      #
       # @param [Integer] message_id The ID of the message to send.
       # @param [String] email The email address of the recipient.
       #
@@ -30,6 +30,51 @@ module MailUp
         @api.post("#{@api.path}/Email/Send", body: {:idMessage => message_id, :Email => email})
       end
 
+      # Schedules a mailing for immediate sending
+      #
+      # @param [Integer] Id Sending.
+      #
+      def send_immediate_confirmation(sending_id)
+       @api.post("#{@api.path}/Email/Sendings/#{sending_id}/Immediate")
+     end
+
+      # Retrieves the earliest date to schedule the given sending task.
+      #
+      # @param [Integer] Id Sending.
+      #
+      def get_deferred_confirmation_date(sending_id)
+        @api.get("#{@api.path}/Email/Sendings/#{sending_id}/Deferred")
+      end
+
+      # Sets up a mailing for scheduled delivery
+      #
+      # @param [Integer] Id Sending.
+      # @param [String] :Date  date/time for a deferred sending(should be UTC).
+      #
+      def send_deferred_confirmation(sending_id, date = nil)
+        @api.post("#{@api.path}/Email/Sendings/#{sending_id}/Deferred", body: {'Date' => date})
+      end
+
+      # Retrieves the list of email messages that are currently queued up for "immediate sending".
+      #
+      #
+      def get_immediate_confirmation_queque
+        @api.get("#{@api.path}/Email/Sendings/Immediate")
+      end
+
+      # Retrieves the list of email messages that are currently queued up for "deferred sending".
+      #
+      #
+      def get_deferred_confirmation_queque
+        @api.get("#{@api.path}/Email/Sendings/Deferred")
+      end
+
+      # Retrieves the list of email messages that are neither "scheduled" nor queued up for "immediate sending".
+      #
+      #
+      def get_undefined_confirmation_queque
+        @api.get("#{@api.path}/Email/Sendings/Undefined")
+      end
     end
   end
 end

data/lib/mailup/console/group.rb

@@ -4,24 +4,36 @@ module MailUp
       attr_accessor :api
 
       def initialize(id, api)
-          @api = api
-          @id = id
+        @api = api
+        @id = id
+      end
+
+      # Import a recipient to the specified group(synchronous import).
+      #
+      # @param [Hash] recipient data, see ConsoleRecipientItems (See http://help.mailup.com/display/mailupapi/Models+v1.1#Modelsv1.1-ConsoleRecipientItem).
+      # @param [Hash] params Optional params or filters:
+      # @option params [Boolean] :ConfirmEmail Confirmed opt-in option. Default false.
+      #
+      # @see http://help.mailup.com/display/mailupapi/Console+methods+v1.1#Consolemethodsv1.1-AsyncImportRecipientsToGroup
+      #
+      def add_recipient(recipient, params = {})
+        @api.post("#{@api.path}/Group/#{@id}/Recipient", body: recipient, params: params)
       end
 
       # Async Import recipients to the specified group.
-      # 
-      # @param [Array] recipients an array ConsoleRecipientItems (See http://help.mailup.com/display/mailupapi/Models+v1.1#Modelsv1.1-ConsoleRecipientItem).
       #
-      # @return [Integer] Number of recipients added to the group.
+      # @param [Array] recipients an array ConsoleRecipientItems (See http://help.mailup.com/display/mailupapi/Models+v1.1#Modelsv1.1-ConsoleRecipientItem).
+      # @param [Hash] params Optional params or filters:
+      # @option params [Boolean] :ConfirmEmail Confirmed opt-in option. Default false.
       #
       # @see http://help.mailup.com/display/mailupapi/Console+methods+v1.1#Consolemethodsv1.1-AsyncImportRecipientsToGroup
       #
-      def add_recipients(recipients)
-        @api.post("#{@api.path}/Group/#{@id}/Recipients", body: recipients)
+      def add_recipients(recipients, params = {})
+        @api.post("#{@api.path}/Group/#{@id}/Recipients", body: recipients, params: params)
       end
-      
+
       # Retrieve the recipients in the specified group.
-      # 
+      #
       # @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.
@@ -37,7 +49,7 @@ module MailUp
       #   * TotalElementsCount [Integer]
       #
       # @see http://help.mailup.com/display/mailupapi/Console+methods+v1.1#Consolemethodsv1.1-GetRecipientsByGroup
-      # 
+      #
       # @example
       #
       #   recipients = mailup.console.group(5).recipients
@@ -49,7 +61,7 @@ module MailUp
       def recipients(params = {})
         @api.get("#{@api.path}/Group/#{@id}/Recipients", params: params)
       end
-      
+
       # Subscribe the recipient with the related id to the specified group.
       #
       # @param [Integer] recipient_id The ID of the recipient.
@@ -66,7 +78,7 @@ module MailUp
       def subscribe(recipient_id)
         @api.post("#{@api.path}/Group/#{@id}/Subscribe/#{recipient_id}")
       end
-      
+
       # Unsubscribe the recipient with the related id from the specified group.
       #
       # @param [Integer] recipient_id The ID of the recipient.
@@ -83,7 +95,7 @@ module MailUp
       def unsubscribe(recipient_id)
         @api.delete("#{@api.path}/Group/#{@id}/Unsubscribe/#{recipient_id}")
       end
-      
+
       # Send email message to all recipient in group.
       #
       # @param [Integer] message_id of the message.

data/lib/mailup/console/import.rb

@@ -4,8 +4,8 @@ module MailUp
       attr_accessor :api
 
       def initialize(id, api)
-          @api = api
-          @id = id
+        @api = api
+        @id = id
       end
 
       # Get import status.
@@ -20,7 +20,7 @@ module MailUp
       #   * NotValidRecipients [Integer]
       #
       # @see http://help.mailup.com/display/mailupapi/Console+methods+v1.1#Consolemethodsv1.1-GetImportStatus
-      # 
+      #
       # @example
       #
       #   status = mailup.console.import(9).status
@@ -33,6 +33,14 @@ module MailUp
         @api.get("#{@api.path}/Import/#{@id}")
       end
 
+      # Get Sending Confirmation Email Id.
+      #
+      # @see http://help.mailup.com/display/mailupapi/Recipients#Recipients-SendConfirmationEmail
+      #
+      def confirmation_email_id
+        @api.get("#{@api.path}/Import/#{@id}/Sending")
+      end
+
     end
   end
 end

data/lib/mailup/console/list.rb

@@ -4,8 +4,8 @@ module MailUp
       attr_accessor :api
 
       def initialize(id, api)
-          @api = api
-          @id = id
+        @api = api
+        @id = id
       end
 
       # Retrieve groups for the specified list
@@ -25,7 +25,7 @@ module MailUp
       #   * TotalElementsCount [Integer]
       #
       # @see http://help.mailup.com/display/mailupapi/Console+methods+v1.1#Consolemethodsv1.1-GetConsoleGroupsByList
-      # 
+      #
       # @example
       #
       #   list = mailup.console.list(2)
@@ -38,7 +38,7 @@ module MailUp
       def groups(params = {})
         @api.get("#{@api.path}/List/#{@id}/Groups", params: params)
       end
-      
+
       # Create a new group for the specified list.
       #
       # @param [Hash] group A hash of group attributes.
@@ -54,7 +54,7 @@ module MailUp
       #   * Deletable [Boolean]
       #
       # @see http://help.mailup.com/display/mailupapi/Console+methods+v1.1#Consolemethodsv1.1-CreateGroup
-      # 
+      #
       # @example
       #
       #   group = {
@@ -69,7 +69,7 @@ module MailUp
       def add_group(group)
         @api.post("#{@api.path}/List/#{@id}/Group", body: group)
       end
-      
+
       # Update a group for the specified list.
       #
       # @param [Hash] group A hash of group attributes.
@@ -85,7 +85,7 @@ module MailUp
       #   * Deletable [Boolean]
       #
       # @see http://help.mailup.com/display/mailupapi/Console+methods+v1.1#Consolemethodsv1.1-UpdateGroup
-      # 
+      #
       # @example
       #
       #   group = {
@@ -100,7 +100,7 @@ module MailUp
       def update_group(group_id, group)
         @api.put("#{@api.path}/List/#{@id}/Group/#{group_id}", body: group)
       end
-      
+
       # Delete a group from the specified list.
       #
       # @param [Integer] group_id The ID of the group to delete.
@@ -136,7 +136,7 @@ module MailUp
       #   * TotalElementsCount [Integer]
       #
       # @see http://help.mailup.com/display/mailupapi/Console+methods+v1.1#Consolemethodsv1.1-GetConsoleGroupsByRecipient
-      # 
+      #
       # @example
       #
       #   groups = mailup.console.list(2).recipient_groups(5)
@@ -150,7 +150,7 @@ module MailUp
       def recipient_groups(recipient_id, params = {})
         @api.get("#{@api.path}/List/#{@id}/Recipient/#{recipient_id}/Groups", params: params)
       end
-      
+
       # Retrieve pending recipients in the specified list.
       #
       # @param [Hash] params Optional params or filters:
@@ -168,7 +168,7 @@ module MailUp
       #   * TotalElementsCount [Integer]
       #
       # @see http://help.mailup.com/display/mailupapi/Console+methods+v1.1#Consolemethodsv1.1-GetPendingRecipientsByList
-      # 
+      #
       # @example
       #
       #   pending = mailup.console.list(2).pending
@@ -182,7 +182,7 @@ module MailUp
       def pending(params = {})
         @api.get("#{@api.path}/List/#{@id}/Recipients/Pending", params: params)
       end
-      
+
       # Retrieve subscribed recipients in the specified list.
       #
       # @param [Hash] params Optional params or filters:
@@ -200,7 +200,7 @@ module MailUp
       #   * TotalElementsCount [Integer]
       #
       # @see http://help.mailup.com/display/mailupapi/Admin+Console+Methods#AdminConsoleMethods-GetSubscribedRecipientsByList
-      # 
+      #
       # @example
       #
       #   subscribed = mailup.console.list(2).subscribed
@@ -214,7 +214,7 @@ module MailUp
       def subscribed(params = {})
         @api.get("#{@api.path}/List/#{@id}/Recipients/Subscribed", params: params)
       end
-      
+
       # Retrieve unsubscribed recipients in the specified list.
       #
       # @param [Hash] params Optional params or filters:
@@ -232,7 +232,7 @@ module MailUp
       #   * TotalElementsCount [Integer]
       #
       # @see http://help.mailup.com/display/mailupapi/Console+methods+v1.1#Consolemethodsv1.1-GetUnsubscribedRecipientsByList
-      # 
+      #
       # @example
       #
       #   unsubscribed = mailup.console.list(2).unsusbcribed
@@ -246,7 +246,29 @@ module MailUp
       def unsubscribed(params = {})
         @api.get("#{@api.path}/List/#{@id}/Recipients/Unsubscribed", params: params)
       end
-      
+
+      # Import a single recipient to a list(synchronous import).
+      #
+      # @param [Hash] recipients An array of Recipients.
+      #   * idRecipient [Integer] (optional)
+      #   * Name [String]
+      #   * Email [String]
+      #   * MobilePrefix [String]
+      #   * MobileNumber [String]
+      #   * Fields [Array]
+      #
+      # @param [Hash] params Optional params or filters:
+      # @option params [Boolean] :ConfirmEmail Confirmed opt-in option. Default false.
+      # @option params [String] :importType By setting as 'asOptout' allows you to "import as unsubscribed" a list of specified recipients.
+      #
+      # @return [Integer] The number of imported recipients.
+      #
+      # @see http://help.mailup.com/display/mailupapi/Console+methods+v1.1#Consolemethodsv1.1-AsyncImportRecipientsToList
+      #
+      def import_recipient(recipient, params = {})
+        @api.post("#{@api.path}/List/#{@id}/Recipient", {params: params, body: recipient})
+      end
+
       # Import multiple recipients to a list.
       #
       # @param [Array<Hash>] recipients An array of Recipients.
@@ -257,14 +279,18 @@ module MailUp
       #   * MobileNumber [String]
       #   * Fields [Array]
       #
+      # @param [Hash] params Optional params or filters:
+      # @option params [Boolean] :ConfirmEmail Confirmed opt-in option. Default false.
+      # @option params [String] :importType By setting as 'asOptout' allows you to "import as unsubscribed" a list of specified recipients.
+      #
       # @return [Integer] The number of imported recipients.
       #
       # @see http://help.mailup.com/display/mailupapi/Console+methods+v1.1#Consolemethodsv1.1-AsyncImportRecipientsToList
       #
-      def import_recipients(recipients)
-        @api.post("#{@api.path}/List/#{@id}/Recipients", body: recipients)
+      def import_recipients(recipients, params = {})
+        @api.post("#{@api.path}/List/#{@id}/Recipients", {params: params, body: recipients})
       end
-      
+
       # Subscribe a recipient from the specified list.
       #
       # @param [Integer] recipient_id The ID of the recipient.
@@ -281,7 +307,7 @@ module MailUp
       def subscribe(recipient_id)
         @api.post("#{@api.path}/List/#{@id}/Subscribe/#{recipient_id}")
       end
-      
+
       # Unsubscribe a recipient in the specified list.
       #
       # @param [Integer] recipient_id The ID of the recipient.
@@ -298,7 +324,7 @@ module MailUp
       def unsubscribe(recipient_id)
         @api.delete("#{@api.path}/List/#{@id}/Unsubscribe/#{recipient_id}")
       end
-      
+
       # Get the enabled tag list for the specified list id.
       #
       # @param [Hash] params Optional params or filters:
@@ -329,7 +355,7 @@ module MailUp
         @api.get("#{@api.path}/List/#{@id}/Tags", params: params)
       end
       alias_method :enabled_tags, :tags
-      
+
       # Add a new tag in the specified list.
       #
       # @param [String] name The name of the tag to create.
@@ -340,7 +366,7 @@ module MailUp
       #   * Enabled [Boolean]
       #
       # @see http://help.mailup.com/display/mailupapi/Console+methods+v1.1#Consolemethodsv1.1-CreateTag
-      # 
+      #
       # @example
       #
       #   new_tag = mailup.console.list(2).add_tag("My New Tag")
@@ -348,7 +374,7 @@ module MailUp
       def add_tag(tag)
         @api.post("#{@api.path}/List/#{@id}/Tag", body: tag)
       end
-      
+
       # Update a tag in the specified list.
       #
       # @param [Hash] tag A hash of tag attributes:
@@ -376,7 +402,7 @@ module MailUp
       def update_tag(tag_id, tag)
         @api.put("#{@api.path}/List/#{@id}/Tag/#{tag_id}", body: tag)
       end
-      
+
       # Delete a tag from the specified list.
       #
       # @param [Integer] idTag The ID of the tag to delete.
@@ -393,7 +419,7 @@ module MailUp
       def delete_tag(tag_id)
         @api.delete("#{@api.path}/List/#{@id}/Tag/#{tag_id}")
       end
-      
+
       # Get the attachment list for the specific message.
       #
       # @param [Integer] message_id The ID of the message.
@@ -419,7 +445,7 @@ module MailUp
       def attachments(message_id, params = {})
         @api.get("#{@api.path}/List/#{@id}/Email/#{message_id}/Attachment", params: params)
       end
-      
+
       # Add an attachment to the specified message.
       #
       # @param [Integer] message_id The ID of the message.
@@ -434,7 +460,7 @@ module MailUp
       #   * Path [String]
       #
       # @see http://help.mailup.com/display/mailupapi/Console+methods+v1.1#Consolemethodsv1.1-AddMessageAttachments
-      # 
+      #
       # @example
       #
       #   attachment = {
@@ -448,7 +474,7 @@ module MailUp
       def add_attachment(message_id, slot, attachment)
         @api.post("#{@api.path}/List/#{@id}/Email/#{message_id}/Attachment/#{slot}", body: attachment)
       end
-      
+
       # Delete an attachment from the specified message.
       #
       # @param [Integer] message_id The ID of the message.
@@ -466,7 +492,7 @@ module MailUp
       def delete_attachment(message_id, slot)
         @api.delete("#{@api.path}/List/#{@id}/Email/#{message_id}/#{slot}")
       end
-      
+
       # Get all the images for the specified list.
       #
       # @param [Hash] params Optional params or filters:
@@ -488,7 +514,7 @@ module MailUp
       def images(params = {})
         @api.get("#{@api.path}/List/#{@id}/Images", params: params)
       end
-      
+
       # Add a new image to the specified mailing list.
       #
       # @param [Hash] image A hash of Image attributes.
@@ -498,7 +524,7 @@ module MailUp
       # @return [String] the created Image URL.
       #
       # @see http://help.mailup.com/display/mailupapi/Console+methods+v1.1#Consolemethodsv1.1-AddListImage
-      # 
+      #
       # @example
       #
       #   image = {
@@ -511,7 +537,7 @@ module MailUp
       def add_image(image)
         @api.post("#{@api.path}/List/#{@id}/Images", body: image)
       end
-      
+
       # Create an email message in the specified list id from template.
       #
       # @param [Integer] template_id The ID of the template.
@@ -522,7 +548,7 @@ module MailUp
       #   * Subject [String]
       #
       # @see http://help.mailup.com/display/mailupapi/Console+methods+v1.1#Consolemethodsv1.1-CreateEmailMessageFromTemplate
-      # 
+      #
       # @example
       #
       #   new_message = mailup.console.list(2).add_message_from_template(5)
@@ -532,7 +558,7 @@ module MailUp
       def add_message_from_template(template_id)
         @api.post("#{@api.path}/List/#{@id}/Email/Template/#{template_id}")
       end
-      
+
       # Create an email message in the specified list id.
       #
       # @param [Hash] message A hash of Message attributes:
@@ -550,7 +576,7 @@ module MailUp
       #   * Subject [String]
       #
       # @see http://help.mailup.com/display/mailupapi/Console+methods+v1.1#Consolemethodsv1.1-CreateEmailMessage
-      # 
+      #
       # @example
       #
       #   new_message = mailup.console.list(2).add_message(message)
@@ -560,7 +586,7 @@ module MailUp
       def add_message(message)
         @api.post("#{@api.path}/List/#{@id}/Email", body: message)
       end
-      
+
       # Modify an email message in the specified list id.
       #
       # @param [Integer] message_id The ID of the message.
@@ -579,7 +605,7 @@ module MailUp
       #   * Subject [String]
       #
       # @see http://help.mailup.com/display/mailupapi/Console+methods+v1.1#Consolemethodsv1.1-UpdateEmailMessage
-      # 
+      #
       # @example
       #
       #   update = mailup.console.list(2).update_message(5, message)
@@ -589,7 +615,7 @@ module MailUp
       def update_message(message_id, message)
         @api.put("#{@api.path}/List/#{@id}/Email/#{message_id}", body: message)
       end
-      
+
       # Modify the email message online visibility.
       #
       # @param [Integer] message_id The ID of the message.
@@ -598,7 +624,7 @@ module MailUp
       # @return [Boolean] `true` if successful.
       #
       # @see http://help.mailup.com/display/mailupapi/Console+methods+v1.1#Consolemethodsv1.1-UpdateOnlineEmailMessageVisibility
-      # 
+      #
       # @example
       #
       #   update = mailup.console.list(2).update_message_visibility(5, true)
@@ -607,7 +633,7 @@ module MailUp
       def update_message_visibility(message_id, visibility)
         @api.put("#{@api.path}/List/#{@id}/Email/#{message_id}/Online/Visibility", body: visibility)
       end
-      
+
       # Delete an email message from the specified list id.
       #
       # @param [Integer] message_id The ID of the message.
@@ -624,7 +650,7 @@ module MailUp
       def delete_message(message_id)
         @api.delete("#{@api.path}/List/#{@id}/Email/#{message_id}")
       end
-      
+
       # Retrieve the email message details by specified id.
       #
       # @param [Integer] message_id The ID of the message.
@@ -651,7 +677,7 @@ module MailUp
       def message_details(message_id)
         @api.get("#{@api.path}/List/#{@id}/Email/#{message_id}")
       end
-      
+
       # Retrieve email messages (cloned and uncloned) for this list.
       #
       # @param [Hash] params Optional params or filters:
@@ -683,7 +709,7 @@ module MailUp
       def emails(params = {})
         @api.get("#{@api.path}/List/#{@id}/Emails", params: params)
       end
-      
+
       # Retrieve the email messages visible online through the website by the specified list id.
       #
       # @param [Hash] params Optional params or filters:
@@ -748,7 +774,7 @@ module MailUp
       def archived_emails(params = {})
         @api.get("#{@api.path}/List/#{@id}/Archived/Emails", params: params)
       end
-      
+
       # Get email message send history.
       #
       # @param [Integer] message_id The ID of the message.
@@ -777,10 +803,12 @@ module MailUp
       def send_history(message_id, params = {})
         @api.get("#{@api.path}/List/#{@id}/Email/#{message_id}/SendHistory", params: params)
       end
-      
+
       # Send an email message to the recipients in the specified list.
       #
       # @param [Integer] message_id The ID of the list.
+      # @param [Hash] params Optional params or filters:
+      # @option params [String] :datetime  date/time for a deferred sending(should be UTC).
       #
       # @return [JSON] A Send object with the following attributes:
       #   * idMessage [Integer]
@@ -796,10 +824,10 @@ module MailUp
       #   send['Sent']
       #   => 1794
       #
-      def send_message(message_id)
-        @api.post("#{@api.path}/List/#{@id}/Email/#{message_id}/Send")
+      def send_message(message_id, params = {})
+        @api.post("#{@api.path}/List/#{@id}/Email/#{message_id}/Send", params: params)
       end
-      
+
       # Retrieve the list of the current defined message templates in the specified list.
       #
       # @param [Hash] params Optional params or filters:
@@ -829,7 +857,7 @@ module MailUp
       def templates(params = {})
         @api.get("#{@api.path}/List/#{@id}/Templates", params: params)
       end
-      
+
       # Retrieve the details for the specified message template in the specified list.
       #
       # @param [Integer] template_id The ID of the template.
@@ -857,7 +885,7 @@ module MailUp
       def template_details(template_id)
         @api.get("#{@api.path}/List/#{@id}/Templates/#{template_id}")
       end
-        
+
     end
   end
 end

data/lib/mailup/console/recipient.rb

@@ -29,11 +29,12 @@ module MailUp
       # @example
       #
       #   recipient = {
-      #     :Name => "Joe Public",
-      #     :Email => "joe@public.com"
+      #     idRecipient: "1234"
+      #     Name: "Joe Public",
+      #     Email: "joe@public.com"
       #   }
       #   updated_recipient = mailup.console.recipient.update(recipient)
-      #   updated_recipient.Name
+      #   updated_recipient['Name']
       #   => "Joe Public"
       #
       def update(recipient)
@@ -60,8 +61,8 @@ module MailUp
       #   fields['Items'].first['Description']
       #   => "Field description..."
       #
-      def fields
-        @api.get("#{@api.path}/Recipient/DynamicFields")
+      def fields(params = {})
+        @api.get("#{@api.path}/Recipient/DynamicFields", params: params)
       end
       
     end

data/lib/mailup/public/console.rb

@@ -38,8 +38,8 @@ module MailUp
       #   trial['id']
       #   => 1329874
       #
-      def new(account = {})
-        @api.post("#{@api.path}/Console/TrialActivation", body: account)
+      def activate_trial(account = {})
+        @api.provisioning_request("#{@api.path}/Console/TrialActivation", account)
       end
 
       # Retrieve the information about current trial activation status.
@@ -67,7 +67,7 @@ module MailUp
       #   => "Status description..."
       #
       def status(account = {})
-        @api.post("#{@api.path}/Console/TrialActivationStatus", body: account)
+        @api.provisioning_request("#{@api.path}/Console/TrialActivationStatus", account)
       end
 
     end

data/lib/mailup/version.rb

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

data/mailup.gemspec

@@ -7,19 +7,21 @@ Gem::Specification.new do |gem|
   gem.name          = "mailup"
   gem.version       = MailUp::VERSION
   gem.platform      = Gem::Platform::RUBY
-  gem.authors       = ["Brian Getting"]
+  gem.authors       = ["Brian Getting", "Rocco Galluzzo"]
   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.licenses    = ['MIT']
+
   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_runtime_dependency 'oauth2', '~> 0.9', '>= 0.9.2'
+
   gem.add_development_dependency "rspec"
   gem.add_development_dependency "rake"
+  gem.add_development_dependency "coveralls"
 end

data/spec/mailup/console/base_spec.rb

@@ -16,7 +16,7 @@ describe MailUp::Console do
     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}")
+        test.should be_an_instance_of(Object.const_get("MailUp").const_get("Console").const_get("#{resource.capitalize}"))
       end
     end
   end
@@ -25,7 +25,7 @@ describe MailUp::Console do
     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}")
+        test.should be_an_instance_of(Object.const_get("MailUp").const_get("Console").const_get("#{resource.capitalize}"))
       end
     end
   end

data/spec/mailup/console/group_spec.rb

@@ -11,10 +11,16 @@ describe MailUp::Console::Group do
 
   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).api.should_receive(:post).with("#{@mailup.console.group(1).api.path}/Group/1/Recipients", {body: payload, params: {}})
     @mailup.console.group(1).add_recipients(payload)
   end
 
+  it "should fire the correct POST request for add_recipient" do
+    payload = Date._jisx0301("empty hash, please")
+    @mailup.console.group(1).api.should_receive(:post).with("#{@mailup.console.group(1).api.path}/Group/1/Recipient", {body: payload, params: {}})
+    @mailup.console.group(1).add_recipient(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: {}})
@@ -38,5 +44,5 @@ describe MailUp::Console::Group do
     @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/import_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe MailUp::Console::Import do
   before(:each) { init_mailup }
 
-  %w(status).each do |method|
+  %w(status confirmation_email_id).each do |method|
     it "should have a #{method} method" do
       @mailup.console.import(1).should respond_to(method.to_sym)
     end
@@ -14,4 +14,10 @@ describe MailUp::Console::Import do
     @mailup.console.import(id).api.should_receive(:get).with("#{@mailup.console.import(id).api.path}/Import/#{id}")
     @mailup.console.import(id).status
   end
+
+  it "should fire the correct GET request for confirmation_email_id" do
+    id = rand(100).abs
+    @mailup.console.import(id).api.should_receive(:get).with("#{@mailup.console.import(id).api.path}/Import/#{id}/Sending")
+    @mailup.console.import(id).confirmation_email_id
+  end
 end

data/spec/mailup/console/list_spec.rb

@@ -59,7 +59,7 @@ describe MailUp::Console::List do
 
   # POST requests
 
-  %w(add_group import_recipients).each do |method|
+  %w(add_group).each do |method|
     it "should fire the correct POST request for #{method}" do
       payload = Date._jisx0301("empty hash, please")
       @mailup.console.list(1).api.should_receive(:post).with("#{@mailup.console.list(1).api.path}/List/1/#{method.split('_').last.capitalize}", {body: payload})
@@ -67,6 +67,25 @@ describe MailUp::Console::List do
     end
   end
 
+  it "should fire the correct POST request for import_recipients" do
+    payload = Date._jisx0301("empty hash, please")
+    @mailup.console.list(1).api.should_receive(:post).with("#{@mailup.console.list(1).api.path}/List/1/Recipients", {body: payload, params: {}})
+    @mailup.console.list(1).send(:import_recipients, payload)
+  end
+
+  it "should fire the correct POST request for import_recipient" do
+    payload = Date._jisx0301("empty hash, please")
+    @mailup.console.list(1).api.should_receive(:post).with("#{@mailup.console.list(1).api.path}/List/1/Recipient", {body: payload, params: {}})
+    @mailup.console.list(1).send(:import_recipient, payload)
+  end
+
+  it "should fire the correct POST request for import_recipients and email optin" do
+    payload = Date._jisx0301("empty hash, please")
+    @mailup.console.list(1).api.should_receive(:post).with("#{@mailup.console.list(1).api.path}/List/1/Recipients",
+      {body: payload, params: {ConfirmEmail: true}})
+    @mailup.console.list(1).send(:import_recipients, payload, {ConfirmEmail: true})
+  end
+
   it "should fire the correct POST request for subscribe" do
     payload = rand(100).abs
     @mailup.console.list(1).api.should_receive(:post).with("#{@mailup.console.list(1).api.path}/List/1/Subscribe/#{payload}")
@@ -106,7 +125,7 @@ describe MailUp::Console::List do
 
   it "should fire the correct POST request for send_message" do
     payload = rand(100).abs
-    @mailup.console.list(1).api.should_receive(:post).with("#{@mailup.console.list(1).api.path}/List/1/Email/#{payload}/Send")
+    @mailup.console.list(1).api.should_receive(:post).with("#{@mailup.console.list(1).api.path}/List/1/Email/#{payload}/Send", {params: {}})
     @mailup.console.list(1).send_message(payload)
   end
 

data/spec/mailup/public/base_spec.rb

@@ -15,7 +15,7 @@ describe MailUp::Public do
     context resource do
       it "should return a #{resource} object" do
         test = @mailup.public.send(resource.to_sym)
-        test.should be_an_instance_of(Object.const_get "MailUp::Public::#{resource.capitalize}")
+        test.should be_an_instance_of(Object.const_get("MailUp").const_get("Public").const_get("#{resource.capitalize}"))
       end
     end
   end

data/spec/mailup/public/console_spec.rb

@@ -3,21 +3,21 @@ require 'spec_helper'
 describe MailUp::Public::Console do
   before(:each) { init_mailup }
 
-  %w(new status).each do |method|
+  %w(activate_trial status).each do |method|
     it "should have a #{method} method" do
       @mailup.public.console.should respond_to(method.to_sym)
     end
   end
 
-  it "should fire the correct POST request for new" do
+  it "should fire the correct POST request for activate_trial" do
     payload = Date._jisx0301("empty hash, please")
-    @mailup.public.console.api.should_receive(:post).with("#{@mailup.public.console.api.path}/Console/TrialActivation", {body: payload})
-    @mailup.public.console.new(payload)
+    @mailup.public.console.api.should_receive(:provisioning_request).with("#{@mailup.public.console.api.path}/Console/TrialActivation", payload)
+    @mailup.public.console.activate_trial(payload)
   end
 
   it "should fire the correct POST request for status" do
     payload = Date._jisx0301("empty hash, please")
-    @mailup.public.console.api.should_receive(:post).with("#{@mailup.public.console.api.path}/Console/TrialActivationStatus", {body: payload})
+    @mailup.public.console.api.should_receive(:provisioning_request).with("#{@mailup.public.console.api.path}/Console/TrialActivationStatus", payload)
     @mailup.public.console.status(payload)
   end
 

data/spec/mailup/stats/base_spec.rb

@@ -15,7 +15,7 @@ describe MailUp::Stats do
     context resource do
       it "should return a #{resource} object" do
         test = @mailup.stats.send(resource.to_sym, 1)
-        test.should be_an_instance_of(Object.const_get "MailUp::Stats::#{resource.capitalize}")
+        test.should be_an_instance_of(Object.const_get("MailUp").const_get("Stats").const_get("#{resource.capitalize}"))
       end
     end
   end

data/spec/spec_helper.rb

@@ -1,6 +1,8 @@
 require 'rubygems'
 require 'bundler/setup'
 require 'mailup'
+require 'coveralls'
+Coveralls.wear!
 
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
@@ -16,6 +18,13 @@ RSpec.configure do |config|
 
   # Global hooks
   config.before(:each) { init_credentials}
+
+  config.mock_with :rspec do |c|
+    c.syntax = [:should, :expect]
+  end
+  config.expect_with :rspec do |c|
+    c.syntax = [:should, :expect]
+  end
 end
 
 # Create Credentials Hash

metadata

@@ -1,55 +1,76 @@
 --- !ruby/object:Gem::Specification
 name: mailup
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Brian Getting
+- Rocco Galluzzo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-23 00:00:00.000000000 Z
+date: 2015-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: A Ruby gem for interacting with the MailUp REST API.
@@ -59,9 +80,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
 - lib/mailup.rb
@@ -98,7 +120,8 @@ files:
 - spec/mailup/stats/recipient_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/mailup/mailup-ruby
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -106,17 +129,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for the MailUp REST API
@@ -136,3 +159,4 @@ test_files:
 - spec/mailup/stats/message_spec.rb
 - spec/mailup/stats/recipient_spec.rb
 - spec/spec_helper.rb
+has_rdoc: 

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2013 Brian Getting
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.