govdelivery-tms 0.8.0

data/lib/govdelivery-tms/resource/command_action.rb

@@ -0,0 +1,17 @@
+module TMS #:nodoc:
+  # CommandAction object represent the results of Commands for a particular input (e.g. an incoming SMS message)
+  #
+  # This resource is read-only.
+  #
+  # ==== Attributes
+  #
+  # * +http_response_code+ - e.g. 200, 404, etc.
+  # * +http_content_type+ - text/html, etc.
+  # * +http_body+ - Request body (if it's <500 characters, otherwise it'll be nil)
+  #
+  class CommandAction
+    include InstanceResource
+
+    readonly_attributes :status, :content_type, :response_body, :created_at
+  end
+end

data/lib/govdelivery-tms/resource/command_type.rb

@@ -0,0 +1,20 @@
+module TMS #:nodoc:
+  # CommandType is a pair of values (name, string_fields, array_fields) that can be attached
+  # to a Keyword (in a Command object).
+  #
+  # This resource is read-only. 
+  #
+  # @attr name [String] The name of the CommandType.
+  # @attr string_fields [Array] An Array of strings representing the different string_fields on this 
+  #   CommandType.  Field values will always be strings.  
+  # @attr array_fields [Array] An array of strings representing the different array fields on this 
+  #   CommandType.  Field values will always be arrays of strings. 
+  #  
+  class CommandType
+
+    include InstanceResource
+    
+    # @!parse attr_reader :string_fields, :array_fields, :name
+    readonly_attributes :name, :string_fields, :array_fields
+  end
+end

data/lib/govdelivery-tms/resource/email_message.rb

@@ -0,0 +1,81 @@
+module TMS #:nodoc:
+  # An EmailMessage is used to create and send a email to a collection of EmailRecipient
+  # objects.  Certain metrics are available after the email is sent, including
+  # the collection of recipients who clicked or opened the email.
+  #
+  # @attr from_name  [String]              The name of the person or entity sending the email.
+  # @attr from_email [String]              Optional - the email address of the person or entity sending the email.  Must be configured in TMS beforehand.  Defaults to the account default from address.
+  # @attr reply_to   [String]              Optional - the email address used for the Reply-To header of this email. Defaults to the account default reply_to_email address (which itself defaults to the default from address if not specified).
+  # @attr errors_to  [String]              Optional - the email address used for the Errors-To header of this email. Defaults to the account default bounce_email address (which itself defaults to the default from address if not specified).
+  # @attr subject    [String]              The subject of the email.
+  # @attr body       [String]              The body of the email.
+  # @attr open_tracking_enabled  [Boolean] Optional - Whether to track opens on this message. Defaults to true.
+  # @attr click_tracking_enabled [Boolean] Optional - Whether to track clicks on links in this message. Defaults to true.
+  # @attr macros     [Hash]                Optional - A dictionary of key/value pairs to use in the subject and body as default macros.
+  # The message-level macros are used when a recipient has no value for a given macro key.
+  #
+  # @example Sending a message
+  #    email_message = client.email_messages.build(:subject => "Great news!",
+  #                                                :body => "You win! <a href='http://example.com/'>click here</a>.",
+  #                                                :from_email => 'foo@example.com')
+  #    email_message.recipients.build(:email => "john@example.com")
+  #    email_message.recipients.build(:email => "jeff@example.com")
+  #    email_message.post
+  #    email_message.get
+  #
+  # @example Viewing recipients that clicked on a link in the email
+  #    email_message.get
+  #    email_message.clicked.get
+  #    email_message.clicked.collection # => [<#EmailRecipient>,...]
+  #
+  # @example Viewing recipients that opened the email
+  #    email_message.get
+  #    email_message.opened.get
+  #    email_message.opened.collection # => [<#EmailRecipient>,...]
+  #
+  # @example Using macros
+  #    email_message = client.email_messages.build(:subject => "Hello [[user]]",
+  #                                                :body => "Your name is [[name]]",
+  #                                                :macros => {:user => "Sir or Madam", :name => "unknown"})
+  #    email_message.recipients.build(:email => "jeff@example.com", :macros => {:user => "jexample", :name => "Jeff Example"})
+  #    email_message.post
+  #
+  class EmailMessage
+    include InstanceResource
+
+    # @!parse attr_accessor :body, :from_name, :from_email, :reply_to, :errors_to, :subject, :open_tracking_enabled, :click_tracking_enabled, :macros
+    writeable_attributes :body,
+                         :click_tracking_enabled,
+                         :errors_to,
+                         :from_email,
+                         :from_name,
+                         :macros,
+                         :open_tracking_enabled,
+                         :reply_to,
+                         :subject
+
+
+    # @!parse attr_reader :created_at, :status
+    readonly_attributes :created_at, :status
+
+    ##
+    # A CollectionResource of EmailRecipients on this email
+    collection_attribute :recipients, 'EmailRecipients'
+
+    ##
+    # A CollectionResource of EmailRecipients that opened this email
+    collection_attribute :opened, 'EmailRecipients'
+
+    ##
+    # A CollectionResource of EmailRecipients that clicked on at least one link in this email
+    collection_attribute :clicked, 'EmailRecipients'
+
+    ##
+    # A CollectionResource of EmailRecipients that sent successfully
+    collection_attribute :sent, 'EmailRecipients'
+
+    ##
+    # A CollectionResource of EmailRecipients that failed, not neccessarily bounced
+    collection_attribute :failed, 'EmailRecipients'
+  end
+end

data/lib/govdelivery-tms/resource/email_recipient.rb

@@ -0,0 +1,31 @@
+module TMS #:nodoc:
+  # An EmailRecipient is used in conjunction with an EmailMessage to send email.
+  #
+  # @attr email [String] The recipient email address
+  # @attr macros [Hash] A dictionary of key/value pairs to resolve in the subject and body as macros. This value can be nil.
+  # 
+  # @example Sending a message
+  #    email_message = client.email_messages.build(:subject => "Great news!", :body => "You win! <a href='http://example.com/'>click here</a>.")
+  #    email_message.recipients.build(:email => "john@example.com")
+  #    email_message.recipients.build(:email => "jeff@example.com")
+  #    email_message.post
+  #    email_message.get
+  #
+  class EmailRecipient
+    include InstanceResource
+
+    # @!parse attr_accessor :email, :macros
+    writeable_attributes :email, :macros
+
+    # @!parse attr_reader :completed_at, :status, :error_message
+    readonly_attributes :completed_at, :status, :error_message
+
+    ##
+    # A CollectionResource of EmailRecipientOpens for this EmailRecipient
+    readonly_collection_attribute :opens, 'EmailRecipientOpens'
+
+    ##
+    # A CollectionResource of EmailRecipientClicks for this EmailRecipient
+    readonly_collection_attribute :clicks, 'EmailRecipientClicks'
+  end
+end

data/lib/govdelivery-tms/resource/email_recipient_click.rb

@@ -0,0 +1,8 @@
+module TMS #:nodoc:
+  class EmailRecipientClick
+    include InstanceResource
+
+    # @!parse attr_reader :event_at, :url
+    readonly_attributes :event_at, :url
+  end
+end

data/lib/govdelivery-tms/resource/email_recipient_open.rb

@@ -0,0 +1,8 @@
+module TMS #:nodoc:
+  class EmailRecipientOpen
+    include InstanceResource
+
+    # @!parse attr_reader :event_at
+    readonly_attributes :event_at
+  end
+end

data/lib/govdelivery-tms/resource/email_template.rb

@@ -0,0 +1,15 @@
+module TMS #:nodoc:
+  class EmailTemplate
+    include InstanceResource
+
+    # @!parse attr_accessor :body, :subject, :link_tracking_parameters, :macros, :open_tracking_enabled, :click_tracking_enabled
+    writeable_attributes :body, :subject, :link_tracking_parameters, :macros, :open_tracking_enabled, :click_tracking_enabled
+
+    linkable_attributes :from_address
+
+    # @!parse attr_reader :created_at
+    readonly_attributes :id, :created_at
+
+    collection_attribute :from_address, 'FromAddress'
+  end
+end

data/lib/govdelivery-tms/resource/from_address.rb

@@ -0,0 +1,10 @@
+module TMS #:nodoc:
+  class FromAddress
+    include InstanceResource
+
+    # @!parse attr_accessor :from_email, :reply_to_email, :bounce_email, :is_default
+    writeable_attributes :from_email, :reply_to_email, :bounce_email, :is_default
+
+    readonly_attributes  :created_at
+  end
+end

data/lib/govdelivery-tms/resource/inbound_sms_message.rb

@@ -0,0 +1,8 @@
+module TMS #:nodoc:
+  class InboundSmsMessage
+    include InstanceResource
+    
+    # @!parse attr_reader :created_at, :completed_at, :from, :body, :to, :command_status
+    readonly_attributes :created_at, :completed_at, :from, :body, :to, :command_status, :keyword_response
+  end
+end

data/lib/govdelivery-tms/resource/ipaws_acknowledgement.rb

@@ -0,0 +1,9 @@
+module TMS
+  class IpawsAcknowledgement
+
+    include InstanceResource
+    
+    readonly_attributes :ACK
+
+  end
+end

data/lib/govdelivery-tms/resource/ipaws_alert.rb

@@ -0,0 +1,38 @@
+module TMS
+  class IpawsAlert
+
+    include InstanceResource
+
+    writeable_attributes(
+      :identifier,
+      :sender,
+      :sent,
+      :status,
+      :msgType,
+      :source,
+      :scope,
+      :restriction,
+      :addresses,
+      :code,
+      :note,
+      :references,
+      :incidents,
+      :info
+    )
+
+    attr_accessor :ipaws_response
+
+    def process_response(response, method)
+      # All IPAWS responses are 200, even if there are errors.
+      # Capture the IPAWS response on a 200 response to POST (create alert)
+      if method == :post && response.status == 200
+        self.ipaws_response = response.body
+        true
+      else
+        self.ipaws_response = nil
+        super
+      end
+    end
+
+  end
+end

data/lib/govdelivery-tms/resource/ipaws_category.rb

@@ -0,0 +1,7 @@
+module TMS
+  class IpawsCategory
+
+    include IpawsStaticResource
+
+  end
+end

data/lib/govdelivery-tms/resource/ipaws_cog_profile.rb

@@ -0,0 +1,29 @@
+module TMS
+  class IpawsCogProfile
+
+    include InstanceResource
+    
+    readonly_attributes(
+      :cogid,
+      :name,
+      :description,
+      :categoryName,
+      :organizationName,
+      :cogEnabled,
+      :caeAuthorized,
+      :caeCmasAuthorized,
+      :eanAuthorized,
+      :allEventCode,
+      :allGeoCode,
+      :easAuthorized,
+      :cmasAlertAuthorized,
+      :cmamTextAuthorized,
+      :publicAlertAuthorized,
+      :broadcastAuthorized,
+      :email,
+      :eventCodes,
+      :geoCodes
+    )
+
+  end
+end

data/lib/govdelivery-tms/resource/ipaws_event_code.rb

@@ -0,0 +1,7 @@
+module TMS
+  class IpawsEventCode
+
+    include IpawsStaticResource
+
+  end
+end

data/lib/govdelivery-tms/resource/ipaws_nwem_area.rb

@@ -0,0 +1,18 @@
+module TMS
+  class IpawsNwemArea
+
+    include InstanceResource
+
+    readonly_attributes(
+      :countyFipsCd,
+      :countyName,
+      :geoType,
+      :stateCd,
+      :stateFips,
+      :stateName,
+      :zoneCd,
+      :zoneName
+    )
+
+  end
+end

data/lib/govdelivery-tms/resource/ipaws_nwem_authorization.rb

@@ -0,0 +1,9 @@
+module TMS
+  class IpawsNwemAuthorization
+
+    include InstanceResource
+
+    readonly_attributes :cogid
+
+  end
+end

data/lib/govdelivery-tms/resource/ipaws_nwem_auxilary_data.rb

@@ -0,0 +1,8 @@
+module TMS
+  class IpawsNwemAuxilaryData
+
+    include InstanceResource
+    include IpawsResponse
+
+  end
+end

data/lib/govdelivery-tms/resource/ipaws_response_type.rb

@@ -0,0 +1,7 @@
+module TMS
+  class IpawsResponseType
+
+    include IpawsStaticResource
+
+  end
+end

data/lib/govdelivery-tms/resource/ipaws_static_resource.rb

@@ -0,0 +1,8 @@
+module TMS
+  module IpawsStaticResource
+    def self.included(base)
+      base.send(:include, TMS::InstanceResource)
+      base.readonly_attributes :value, :description, :cap_exchange, :core_ipaws_profile, :nwem, :eas_and_public, :cmas
+    end
+  end
+end

data/lib/govdelivery-tms/resource/keyword.rb

@@ -0,0 +1,30 @@
+module TMS #:nodoc:
+  # A Keyword is a word that TMS will detect in an incoming SMS message.  Keywords can have Commands, and
+  # when an incoming text message has a keyword, TMS will execute the keyword's Commands.  Keywords may 
+  # also have a response text field.  If the response text is not blank, the system will send an SMS reply to the user
+  # immediately with the given text. 
+  #
+  # @attr name [String] The name of the keyword.  The system will scan an incoming SMS for this string (in a case-insensitive manner). 
+  # @attr response_text [String] (Optional) The static text with which to reply to an SMS to this keyword.
+  #   This value can be blank, in which case the handset user will not receive a response. 
+  #   Note that all keyword commands will be executed, regardless of the value of response_text.
+  #  
+  # @example
+  #   keyword = client.keywords.build(:name => "HOWDY")
+  #   keyword.post
+  #   keyword.name = "INFO"
+  #   keyword.response_text = "Please call our support staff at 1-555-555-5555"
+  #   keyword.put
+  #   keyword.delete
+  class Keyword
+    include InstanceResource
+
+    # @!parse attr_accessor :name, :response_text
+    writeable_attributes :name, :response_text
+
+    ##
+    # A CollectionResource of Command objects
+    collection_attributes :commands
+
+  end
+end

data/lib/govdelivery-tms/resource/recipient.rb

@@ -0,0 +1,10 @@
+module TMS #:nodoc:
+  class Recipient
+    include InstanceResource
+    # @!parse attr_accessor :phone
+    writeable_attributes :phone
+
+    # @!parse attr_reader :formatted_phone, :error_message, :status, :completed_at
+    readonly_attributes :formatted_phone, :error_message, :status, :completed_at
+  end
+end

data/lib/govdelivery-tms/resource/sms_message.rb

@@ -0,0 +1,35 @@
+module TMS #:nodoc:
+  # An SMSMessage is used to create and send a text message to a collection of Recipient
+  # objects.
+  #
+  #
+  # @attr body [String] The content of the SMS.  This field will be truncated to 160 characters.
+  #
+  # @example
+  #    sms = client.sms_messages.build(:body => "Hello")
+  #    sms.recipients.build(:phone => "+18001002000")
+  #    sms.post
+  #    sms.get
+  class SmsMessage
+    include InstanceResource
+
+    # @!parse attr_accessor :body
+    writeable_attributes :body
+
+    # @!parse attr_reader :created_at, :completed_at, :status
+    readonly_attributes :created_at, :completed_at, :status
+
+    ##
+    # A CollectionResource of Recipient objects
+    collection_attributes :recipients
+
+    ##
+    # A CollectionResource of Recipients that sent successfully
+    collection_attribute :sent, 'Recipients'
+
+    ##
+    # A CollectionResource of Recipients that failed
+    collection_attribute :failed, 'Recipients'
+
+  end
+end