tms_client 0.1.0 → 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b7a0be5e64161ecf0605c965d2bb949ec4b157db
+  data.tar.gz: 6f725c6cb7c2f771dd7cbc07d67f00ad113af1fb
+SHA512:
+  metadata.gz: 8ede49f2709329392caa5e954071b769f136abe14f6ad32f7f1f8ca617314fe0f07a4025c6e1dc2d6cd7bd4298bc0d8d961381d366e46671d38da898a2b16197
+  data.tar.gz: 4bc8ad9a68092470eea57fd069d6cc6fba3c1b0491f0c28489be27141a3ec25f8f760078e2e53ec76ced4edb35cf4062d72cd03068a323ade5f46b50f9303abb

data/Gemfile

@@ -1,11 +1,13 @@
 source "https://rubygems.org"
 gemspec
 
-group :development do
+group :development, :test do
   gem 'rspec'
   gem 'rake'
-  gem 'redcarpet'
+  gem 'redcarpet', :platform => :ruby
   gem 'yard'
   gem 'guard-rspec'
-  gem 'rubygems-tasks', :git => 'https://github.com/postmodern/rubygems-tasks.git'
-end
+  gem 'mail'
+  gem 'rubygems-tasks', :git => 'https://github.com/postmodern/rubygems-tasks.git', :platform => :ruby
+end
+

data/README.md

@@ -51,14 +51,15 @@ message.href             # "/messages/sms/87"
 message.get              # <TMS::SmsMessage href=/messages/sms/87 attributes={...}>
 ```
 
-### Sending Email
+### Sending an Email
 
 ```ruby
-message = client.email_messages.build(:body=>'<p><a href="http://example.com">Visit here</a>', :subject => 'Hey')
+message = client.email_messages.build(:body=>'<p><a href="http://example.com">Visit here</a>', 
+                                      :subject => 'Hey')
 message.recipients.build(:email=>'example1@example.com')
-message.recipients.build(:email=>'example2@example.com')
+message.recipients.build(:email=>'')
 message.post             # true
-message.recipients.collection.detect{|r| r.errors } # {"phone"=>["is not a number"]}
+message.recipients.collection.detect{|r| r.errors } # {"email"=>["can't be blank"]}
 # save succeeded, but we have one bad recipient
 message.href             # "/messages/email/87"
 message.get              # <TMS::EmailMessage href=/messages/email/88 attributes={...}>
@@ -113,8 +114,9 @@ Command Types are the available commands that can be used to respond to an incom
 ```ruby 
 command_types = client.command_types.get
 command_types.collection.each do |at|
-  puts at.name   # "forward"
-  puts at.fields # ["url", "http_method", ...]
+  puts at.name          # "forward"
+  puts at.string_fields # ["url", ...]
+  puts at.array_fields  # ["foo", ...]
 end
 ```
 
@@ -123,7 +125,7 @@ Keywords are chunks of text that are used to match an incoming SMS message.
 
 ```ruby 
 # CRUD
-keyword = client.keywords.build(:name => "BUSRIDE")
+keyword = client.keywords.build(:name => "BUSRIDE", :response_text => "Visit example.com/rides for more info")
 keyword.post                # true
 keyword.name                # 'busride'
 keyword.name = "TRAINRIDE"
@@ -134,7 +136,7 @@ keyword.delete              # true
 # list
 keywords = client.keywords.get
 keywords.collection.each do |k|
-  puts k.name
+  puts k.name, k.response_text
 end
 ```
 
@@ -174,6 +176,27 @@ logger = Logger.new(STDOUT)
 client = TMS::Client.new('username', 'password', :logger => logger)
 ```
 
+ActionMailer integration
+------------------------
+
+You can use TMS from the mail gem or ActionMailer as a delivery method.
+
+Gemfile
+```ruby
+gem 'tms_client', :require=>'tms_client/mail/delivery_method'
+```
+
+config/environment.rb
+```ruby
+config.action_mailer.delivery_method = :govdelivery_tms
+config.action_mailer.govdelivery_tms_settings = {
+    :username=>'email@foo.com',
+    :password=>'pass',
+    :api_root=>'https://stage-tms.govdelivery.com'
+    }
+```
+
+
 Generating Documentation
 ------------------------
 This project uses [yard](https://github.com/lsegal/yard) to generate documentation.  To generate API documentation yourself, use the following series of commands from the project root: 

data/lib/tms_client/client.rb

@@ -5,18 +5,22 @@ class TMS::Client
 
   attr_accessor :connection, :href
 
+  DEFAULTS = {:api_root => 'http://localhost:3000', :logger => nil}.freeze
+
   # Create a new client and issue a request for the available resources for a given account.
   #
-  # === Options
-  # * +:api_root+ - The root URL of the TMS api. Defaults to localhost:3000
-  # * +:logger+   - An instance of a Logger class (http transport information will be logged here) - defaults to nil
+  # @param [String] username The username of your account
+  # @param [String] password The password of your account
+  # @param [Hash] options
+  # @option options [String] :api_root The root URL of the TMS api. Defaults to localhost:3000
+  # @option options [Logger] :logger An instance of a Logger class (http transport information will be logged here) - defaults to nil
   #
-  # === Examples
+  # @example
   #   client = TMS::Client.new("foo@example.com", "onetwothree", {
   #                               :api_root => "https://tms.govdelivery.com",
   #                               :logger => Logger.new(STDOUT)})
   #
-  def initialize(username, password, options = {:api_root => 'http://localhost:3000', :logger => nil})
+  def initialize(username, password, options = DEFAULTS)
     @api_root = options[:api_root]
     connect!(username, password, options[:logger])
     discover!

data/lib/tms_client/errors.rb

@@ -1,5 +1,38 @@
 module TMS
   module Errors
+    class ServerError
+      def initialize(response)
+        super("TMS client encountered a server error: #{response.status} \n#{response.body}")
+      end
+    end
+    class NoRelation < StandardError
+      def initialize(rel=nil, obj=nil)
+        message = "no link relation "
+        message << "'#{rel}' " if rel
+        message << 'is available'
+        message << " for #{obj}" if obj
+        super(message)
+      end
+    end
+    class InvalidVerb
+      attr_reader :record
+
+      def initialize(record_or_string)
+        if record_or_string.respond_to?(:href)
+          @record = record_or_string
+          super("Couldn't POST #{record.class} to #{record.href}: #{record.errors.join(', ')}")
+        else
+          super(record_or_string)
+        end
+
+      end
+    end
+    class InvalidPost < InvalidVerb
+    end
+    class InvalidPut < InvalidVerb
+    end
+    class InvalidDelete < InvalidVerb
+    end
     class InvalidGet < StandardError
       def initialize(message=nil)
         super(message || "Can't GET a resource after an invalid POST; either create a new object or fix errors")

data/lib/tms_client/instance_resource.rb

@@ -6,7 +6,7 @@ module TMS::InstanceResource
   end
 
   module ClassMethods
-    #
+    ##
     # Writeable attributes are sent on POST/PUT.
     #
     def writeable_attributes(*attrs)
@@ -18,7 +18,7 @@ module TMS::InstanceResource
       @writeable_attributes
     end
 
-    #
+    ##
     # Readonly attributes don't get POSTed.
     # (timestamps are included by default)
     #
@@ -31,15 +31,16 @@ module TMS::InstanceResource
       @readonly_attributes
     end
 
-    #
+    ##
     # For collections that are represented as attributes (i.e. inline, no href)
     #
-    # # message.rb
-    # collection_attributes :recipients
+    # @example
+    #     collection_attributes :recipients
+    #
     def collection_attributes(*attrs)
       @collection_attributes ||= []
       if attrs.any?
-        @collection_attributes.map!(&:to_sym).concat(attrs).uniq! if attrs.any?
+        @collection_attributes.map!(&:to_sym).concat(attrs).uniq!
         @collection_attributes.each { |a| setup_collection(a) }
       end
       @collection_attributes
@@ -49,18 +50,32 @@ module TMS::InstanceResource
       @custom_class_names ||= {}
     end
 
-    #
+    ##
     # For collections that are represented as attributes (i.e. inline, no href)
     # and that have a class name other than the one we would infer.
     #
-    # # email.rb
-    # collection_attributes :recipients, 'EmailRecipient'
+    # @example
+    #    collection_attributes :recipients, 'EmailRecipient'
+    #
     def collection_attribute(attr, tms_class)
       @collection_attributes ||= []
       @collection_attributes.push(attr).uniq!
       setup_collection(attr, TMS.const_get(tms_class))
     end
 
+    ##
+    # Read-only collection attributes don't get POSTed. 
+    # Use this for collections that are represented as attributes, but cannot be modified. 
+    #
+    # @example
+    #      readonly_collection_attribute :opens
+    #
+    def readonly_collection_attribute(attr, tms_class)
+      @readonly_collection_attributes ||= []
+      @readonly_collection_attributes.push(attr).uniq!
+      setup_collection(attr, TMS.const_get(tms_class))
+    end
+
     def setup_attributes(attrs, readonly=false)
       attrs.map(&:to_sym).each do |property|
         self.send :define_method, :"#{property}=", &lambda { |v| @attributes[property] = v } unless readonly
@@ -89,60 +104,24 @@ module TMS::InstanceResource
 
     def get
       raise TMS::Errors::InvalidGet if self.new_record?
-      set_attributes_from_hash(self.client.get(href).body)
-      self
+      process_response(client.get(self.href), :get)
     end
 
     def post
-      response = client.post(self)
+      self.errors = nil
+      process_response(client.post(self), :post)
+    end
 
-      case response.status
-        when 200..299
-          set_attributes_from_hash(response.body)
-          self.new_record=false
-          return true
-        when 401
-          raise Exception.new("401 Not Authorized")
-        when 404
-          raise(Exception.new("Can't POST to #{self.href}"))
-        else
-          if response.body['errors']
-            self.errors = response.body['errors']
-          end
-      end
-      return false
+    def post!
+      self.post or raise TMS::Errors::InvalidPost.new(self)
     end
 
     def put
-      response = client.put(self)
-      case response.status
-        when 200
-          self.new_record=false
-          set_attributes_from_hash(response.body)
-          return true
-        when 401
-          raise Exception.new("401 Not Authorized")
-        when 404
-          raise(Exception.new("Can't POST to #{self.href}"))
-        else
-          if response.body['errors']
-            self.errors = response.body['errors']
-          end
-      end
-      return false
+      process_response(client.put(self), :put)
     end
 
     def delete
-      response = self.client.delete(href)
-      case response.status
-        when 200
-          return true
-        else
-          if response.body['errors']
-            self.errors = response.body['errors']
-          end
-      end
-      return false
+      process_response(client.delete(self.href), :delete)
     end
 
     def to_s
@@ -166,7 +145,28 @@ module TMS::InstanceResource
       self.class.custom_class_names[rel.to_sym] || super
     end
 
-    private
+    def process_response(response, method)
+      error_class = TMS::Errors.const_get("Invalid#{method.to_s.capitalize}")
+      case response.status
+        when 204
+          return true
+        when 200..299
+          set_attributes_from_hash(response.body) if response.body.is_a?(Hash)
+          self.new_record=false
+          return true
+        when 401
+          raise error_class.new("401 Not Authorized")
+        when 404
+          raise(error_class.new("Can't POST to #{self.href}"))
+        when 500..599
+          raise(TMS::Errors::ServerError.new(response))
+        else # 422?
+          if response.body['errors']
+            self.errors = response.body['errors']
+          end
+      end
+      return false
+    end
 
     def set_attributes_from_hash(hash)
       hash.reject { |k, _| k=~/^_/ }.each do |property, value|

data/lib/tms_client/mail/delivery_method.rb

@@ -0,0 +1,57 @@
+require 'tms_client'
+require 'mail'
+require 'mail/check_delivery_params'
+module TMS
+  module Mail
+    # Use TMS from the mail gem or ActionMailer as a delivery method.
+    #
+    #   # Gemfile
+    #   gem 'tms_client', :require=>'tms_client/mail/delivery_method'
+    #
+    #   # config/environment.rb
+    #   config.action_mailer.delivery_method = :govdelivery_tms
+    #   config.action_mailer.govdelivery_tms_settings = {
+    #     :username=>'email@foo.com',
+    #     :password=>'pass',
+    #     :api_root=>'https://stage-tms.govdelivery.com'
+    #     }
+    class DeliveryMethod
+      include ::Mail::CheckDeliveryParams
+
+      def initialize(values)
+        self.settings = values
+      end
+
+      attr_accessor :settings
+
+      def deliver!(mail)
+        #check_params(mail)
+        raise TMS::Errors::NoRelation.new('email_messages', client) unless client.respond_to?(:email_messages)
+
+        envelope_from = mail.return_path || mail.sender || mail.from_addrs.first
+
+        tms_message = client.email_messages.build(
+          :from_name => mail[:from].display_names.first,
+          :subject => mail.subject,
+          :body => (mail.body || mail.html_part.body || mail.text_part.body).to_s
+        )
+
+        mail.to.each { |recip| tms_message.recipients.build(:email => recip) }
+        tms_message.post!
+        tms_message
+      end
+
+      def client
+        @client ||= TMS::Client.new(settings[:username], settings[:password], settings)
+      end
+    end
+  end
+end
+
+if defined?(ActionMailer)
+  ActionMailer::Base.add_delivery_method :govdelivery_tms, TMS::Mail::DeliveryMethod, {
+    :username => nil,
+    :password => nil,
+    :logger => ActionMailer::Base.logger,
+    :api_root => TMS::Client::DEFAULTS[:api_root]}
+end

data/lib/tms_client/resource/collections.rb

@@ -32,7 +32,7 @@ end
 
 # A collection of Keyword objects.
 #
-# === Example
+# @example
 #    keywords = client.keywords.get
 #
 class TMS::Keywords
@@ -49,7 +49,7 @@ end
 #
 # This resource is read-only.
 #
-# === Example
+# @example
 #    client.command_types.get
 #    client.command_types.collection.each {|at| ... }
 class TMS::CommandTypes
@@ -59,3 +59,7 @@ end
 class TMS::Commands
   include TMS::CollectionResource
 end
+
+class TMS::CommandActions
+  include TMS::CollectionResource
+end

data/lib/tms_client/resource/command.rb

@@ -2,13 +2,11 @@ module TMS #:nodoc:
   # A command is a combination of behavior and parameters that should be executed 
   # when an incoming SMS message matches the associated Keyword.
   #
-  # ==== Attributes  
+  # @attr name [String] The name of the command.  This will default to the command_type if not supplied. 
+  # @attr command_type [String] The type of this command.  A list of valid types can be found by querying the CommandType list. 
+  # @attr params [Hash] A Hash of string/string pairs used as configuration for this command.  
   # 
-  # * +name+ - The name of the command.  This will default to the command_type if not supplied. 
-  # * +command_type+ - The type of this command.  A list of valid types can be found by querying the CommandType list. 
-  # * +params+ - A Hash of string/string pairs used as configuration for this command.  
-  # 
-  # === Examples
+  # @example
   #    command = keyword.commands.build(:name => "subscribe to news", :command_type => "dcm_subscribe", :dcm_account_code => "NEWS", :dcm_topic_codes => "NEWS_1, NEWS_2")
   #    command.post
   #    command.dcm_topic_codes += ", NEWS_5"

data/lib/tms_client/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/tms_client/resource/command_type.rb

@@ -1,20 +1,20 @@
 module TMS #:nodoc:
-  # CommandType is a pair of values (name, fields) that can be attached
+  # 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. 
   #
-  # ==== Attributes  
-  #  
-  # * +name+ - The name of the CommandType.
-  # * +fields+ - An Array of strings representing the different fields on this 
+  # @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 :fields, :name
-    readonly_attributes :name, :fields
+    # @!parse attr_reader :string_fields, :array_fields, :name
+    readonly_attributes :name, :string_fields, :array_fields
   end
 end

data/lib/tms_client/resource/email_message.rb

@@ -2,37 +2,44 @@ 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. 
-  # 
-  #
-  # ==== Attributes  
-  # 
-  # * +from_name+ - The name of the person or entity sending the email.  
-  # * +subject+   - The subject of the email
-  # * +body+      - The body of the email
   #
+  # @attr from_name [String]             The name of the person or entity sending the email.  
+  # @attr subject   [String]             The subject of the email
+  # @attr body      [String]             The body of the email
+  # @attr open_tracking_enabled [Boolean] Whether to track opens on this message. Optional, defaults to true.
+  # @attr click_tracking_enabled [Boolean] Whether to track clicks on links in this message. Optional, defaults to true.
+  # @attr macros [Hash]                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
+  # @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
   #
-  # Viewing recipients that clicked on a link in the email
+  # @example Viewing recipients that clicked on a link in the email
   #    email_message.get
   #    email_message.clicked.get
   #    email_message.clicked.collection # => [<#EmailRecipient>,...]
   #
-  # Viewing recipients that opened the email
+  # @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, :subject
-    writeable_attributes :body, :from_name, :subject
+    # @!parse attr_accessor :body, :from_name, :subject, :open_tracking_enabled, :click_tracking_enabled, :macros
+    writeable_attributes :body, :from_name, :subject, :open_tracking_enabled, :click_tracking_enabled, :macros
 
     # @!parse attr_reader :created_at, :status
     readonly_attributes :created_at, :status

data/lib/tms_client/resource/email_recipient.rb

@@ -1,19 +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
-    writeable_attributes :email
+    # @!parse attr_accessor :email, :macros
+    writeable_attributes :email, :macros
 
     # @!parse attr_reader :completed_at
     readonly_attributes :completed_at
 
     ##
     # A CollectionResource of EmailRecipientOpens for this EmailRecipient
-    collection_attribute :opens, 'EmailRecipientOpens'
+    readonly_collection_attribute :opens, 'EmailRecipientOpens'
 
     ##
     # A CollectionResource of EmailRecipientClicks for this EmailRecipient
-    collection_attribute :clicks, 'EmailRecipientClicks'
+    readonly_collection_attribute :clicks, 'EmailRecipientClicks'
   end
 end

data/lib/tms_client/resource/inbound_sms_message.rb

@@ -2,7 +2,7 @@ module TMS #:nodoc:
   class InboundSmsMessage
     include InstanceResource
     
-    # @!parse attr_reader :created_at, :completed_at, :from, :body, :to
-    readonly_attributes :created_at, :completed_at, :from, :body, :to
+    # @!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/tms_client/resource/keyword.rb

@@ -1,22 +1,26 @@
 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. 
+  # 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. 
   #
-  # ==== Attributes  
-  # 
-  # * +name+ - The name of the keyword.
+  # @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.
   #  
-  # === Examples
+  # @example
   #   keyword = client.keywords.build(:name => "HOWDY")
   #   keyword.post
-  #   keyword.name = "DOODY"
+  #   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
-    writeable_attributes :name
+    # @!parse attr_accessor :name, :response_text
+    writeable_attributes :name, :response_text
 
     ##
     # A CollectionResource of Command objects

data/lib/tms_client/resource/sms_message.rb

@@ -3,11 +3,9 @@ module TMS #:nodoc:
   # objects.
   # 
   #
-  # ==== Attributes  
+  # @attr body [String] The content of the SMS.  This field will be truncated to 160 characters. 
   # 
-  # * +body+ - The content of the SMS.  This field will be truncated to 160 characters. 
-  # 
-  # === Example
+  # @example
   #    sms = client.sms_messages.build(:body => "Hello")
   #    sms.recipients.build(:phone => "+18001002000")
   #    sms.post

data/lib/tms_client/resource/voice_message.rb

@@ -4,11 +4,9 @@ module TMS #:nodoc:
   # played to them.  Accepted sound formats include +wav+, +mp3+, and +aiff+. 
   # 
   #
-  # ==== Attributes  
+  # @attr play_url [String] The url to the sound file to be played back to the call recipients
   # 
-  # * +play_url+ - The url to the sound file to be played back to the call recipients
-  # 
-  # === Example
+  # @example
   #    voice_message = client.voice_messages.build(:play_url => "http://example.com/emergency_weather.mp3")
   #    voice_message.recipients.build(:phone => "+18001002000")
   #    voice_message.post

data/lib/tms_client/version.rb

@@ -1,3 +1,3 @@
 module TMS #:nodoc:
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/tms_client.rb

@@ -28,6 +28,7 @@ require 'tms_client/resource/voice_message'
 require 'tms_client/resource/email_message'
 require 'tms_client/resource/inbound_sms_message'
 require 'tms_client/resource/command_type'
+require 'tms_client/resource/command_action'
 require 'tms_client/resource/command'
 require 'tms_client/resource/keyword'
 

data/spec/command_types_spec.rb

@@ -9,12 +9,21 @@ describe TMS::CommandTypes do
       @command_types = TMS::CommandTypes.new(client, '/command_types')
     end
     it 'should GET ok' do
-      body = [{"fields"=>["dcm_account_codes"], "name"=>"dcm_unsubscribe"}, 
-              {"fields"=>["dcm_account_code", "dcm_topic_codes"], "name"=>"dcm_subscribe"}, 
-              {"fields"=>["http_method", "username", "password", "url"], "name"=>"forward"}] 
+      body = [{"name"=>"dcm_unsubscribe",
+               "string_fields"=>[],
+               "array_fields"=>["dcm_account_codes"]},
+              {"name"=>"dcm_subscribe",
+               "string_fields"=>["dcm_account_code"],
+               "array_fields"=>["dcm_topic_codes"]},
+              {"name"=>"forward",
+               "string_fields"=>["http_method", "username", "password", "url"],
+               "array_fields"=>[]}] 
       @command_types.client.should_receive(:get).and_return(double('response', :body => body, :status => 200, :headers => {}))
       @command_types.get
       @command_types.collection.length.should == 3
+      ct = @command_types.collection.find{|c| c.name == "dcm_subscribe"}
+      ct.array_fields.should eq(["dcm_topic_codes"])
+      ct.string_fields.should eq(["dcm_account_code"])
     end
   end
 end

data/spec/instance_resource_spec.rb

@@ -3,6 +3,7 @@ class Foo
   include TMS::InstanceResource
   writeable_attributes :bar
   collection_attribute :blah, 'EmailMessage'
+  readonly_collection_attribute :shah, 'EmailMessage'
 end
 
 describe TMS::InstanceResource do
@@ -27,6 +28,7 @@ describe TMS::InstanceResource do
 
     it 'should correctly reflect on collection resources' do
       @instance_resource.blah.class.should == TMS::EmailMessage
+      @instance_resource.shah.class.should == TMS::EmailMessage
     end
   end
 end

data/spec/keyword_spec.rb

@@ -6,22 +6,25 @@ describe TMS::Keyword do
       double('client')
     end
     before do
-      @keyword = TMS::Keyword.new(client, nil, {:name => 'LOL'})
+      @keyword = TMS::Keyword.new(client, nil, {:name => 'LOL', :response_text => 'very funny!'})
     end
     it 'should initialize with attrs' do
       @keyword.name.should == 'LOL'
+      @keyword.response_text.should == 'very funny!'
     end
     it 'should post successfully' do
       response = {:name => 'lol'}
       @keyword.client.should_receive('post').with(@keyword).and_return(double('response', :status => 201, :body => response))
       @keyword.post
       @keyword.name.should == 'lol'
+      @keyword.response_text.should == 'very funny!'
     end
     it 'should handle errors' do
       response = {'errors' => {:name => "can't be nil"}}
       @keyword.client.should_receive('post').with(@keyword).and_return(double('response', :status => 422, :body => response))
       @keyword.post
       @keyword.name.should == 'LOL'
+      @keyword.response_text.should == 'very funny!'
       @keyword.errors.should == {:name => "can't be nil"}
     end
   end
@@ -35,18 +38,19 @@ describe TMS::Keyword do
       @keyword = TMS::Keyword.new(client, '/keywords/99', {})
     end
     it 'should GET cleanly' do
-      response = {:name => 'FOO'}
+      response = {:name => 'FOO', :response_text => 'hello'}
       @keyword.client.should_receive('get').with(@keyword.href).and_return(double('response', :status => 200, :body => response))
       @keyword.get
       @keyword.name.should == 'FOO'
+      @keyword.response_text.should == 'hello'
     end
     it 'should PUT cleanly' do
       @keyword.name = "GOVLIE"
-      response  = {:name => 'govlie'}
+      response  = {:name => 'govlie', :response_text => nil}
       @keyword.client.should_receive('put').with(@keyword).and_return(double('response', :status => 200, :body => response))
       @keyword.put
       @keyword.name.should == 'govlie'
-
+      @keyword.response_text.should be_nil
     end
     it 'should DELETE cleanly' do
       @keyword.client.should_receive('delete').with(@keyword.href).and_return(double('response', :status => 200, :body => ''))

data/spec/mail/delivery_method_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+require 'mail'
+require 'tms_client/mail/delivery_method'
+describe TMS::Mail::DeliveryMethod do
+  subject { TMS::Mail::DeliveryMethod.new({}) }
+  let(:client) { stub('TMS::Client') }
+  let(:email_messages) { double('email_messages') }
+  let(:tms_message) { double('tms_message', :recipients => double(:build => TMS::Recipient.new('href'))) }
+
+  it 'should work with a basic Mail::Message' do
+    mail = Mail.new do
+      subject 'hi'
+      from '"My mom" <my@mom.com>'
+      to '"A Nice Fellow" <tyler@sink.govdelivery.com>'
+      body '<blink>HI</blink>'
+    end
+    client.stub(:email_messages).and_return(email_messages)
+    subject.stub(:client).and_return(client)
+    email_messages.should_receive(:build).with(
+      :from_name => mail[:from].display_names.first,
+      :subject => mail.subject,
+      :body => mail.body.to_s || mail.html_part.body.to_s || mail.text_part.body.to_s
+    ).and_return(tms_message)
+    tms_message.should_receive(:post!).and_return(true)
+
+    subject.deliver!(mail)
+  end
+
+end

metadata

@@ -1,65 +1,58 @@
 --- !ruby/object:Gem::Specification
 name: tms_client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: 0.1.1
 platform: ruby
 authors:
 - GovDelivery
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-27 00:00:00.000000000 Z
+date: 2013-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: ! 'A reference implementation, written in Ruby, to interact with GovDelivery''s
+description: 'A reference implementation, written in Ruby, to interact with GovDelivery''s
   TMS API. The client is compatible with Ruby versions 1.8.7 and 1.9.3. '
 email:
 - support@govdelivery.com
@@ -79,9 +72,11 @@ files:
 - lib/tms_client/instance_resource.rb
 - lib/tms_client/link_header.rb
 - lib/tms_client/logger.rb
+- lib/tms_client/mail/delivery_method.rb
 - lib/tms_client/request.rb
 - lib/tms_client/resource/collections.rb
 - lib/tms_client/resource/command.rb
+- lib/tms_client/resource/command_action.rb
 - lib/tms_client/resource/command_type.rb
 - lib/tms_client/resource/email_message.rb
 - lib/tms_client/resource/email_recipient.rb
@@ -102,33 +97,33 @@ files:
 - spec/instance_resource_spec.rb
 - spec/keyword_spec.rb
 - spec/keywords_spec.rb
+- spec/mail/delivery_method_spec.rb
 - spec/message_spec.rb
 - spec/messages_spec.rb
 - spec/spec_helper.rb
 - spec/tms_client_spec.rb
 homepage: http://govdelivery.com
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A ruby client to interact with the GovDelivery TMS REST API.
 test_files:
 - spec/client_spec.rb
@@ -137,6 +132,7 @@ test_files:
 - spec/instance_resource_spec.rb
 - spec/keyword_spec.rb
 - spec/keywords_spec.rb
+- spec/mail/delivery_method_spec.rb
 - spec/message_spec.rb
 - spec/messages_spec.rb
 - spec/spec_helper.rb