tms_client 0.4.1 → 0.5.1

data/Gemfile

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

data/README.md

@@ -80,6 +80,37 @@ message.href             # "/messages/voice/87"
 message.get              # <TMS::VoiceMessage href=/messages/voice/87 attributes={...}>
 ```
 
+### Obtaining IPAWS Ack ###
+```ruby
+client.ipaws_acknowledgement.get
+client.ipaws_acknowledgement.ACK # "PONG"
+```
+
+### Obtaining IPAWS COG Profile
+```ruby
+client.ipaws_cog_profile.get
+client.ipaws_cog_profile.attributes # {:cogid=>"120082", :name=>"GovDelivery" ... }
+```
+
+### Determining NWEM COG Authorization ###
+```ruby
+client.ipaws_nwem_authorization.get
+client.ipaws_nwem_authorization.cogid # true
+```
+
+### Obtaining NWEM Auxilary Data (Authorized areas) ###
+```ruby
+client.ipaws_nwem_areas.get
+client.ipaws_nwem_areas.collection.first.countyFipsCd # "51013"
+```
+
+### Sending an IPAWS Alert ###
+```ruby
+alert = client.ipaws_alerts.build({ identifier: "CAP12-TEST-12345", sender: 'test@open.com' ...})
+alert.post # true
+alert.ipaws_response # { "identifier"=>"CAP12-TEST-1397743203", "statuses"=> [{"CHANNELNAME"=>"CAPEXCH" ... }]}
+```
+
 Metrics
 -------
 ### Viewing recipients that clicked on a link in an email
@@ -209,9 +240,20 @@ rake yard
 ```
 The generated documentation will be placed in the `doc` folder.
 
+
+Running Tests
+-------------
+```ruby
+appraisal install
+# optionally specify an activesupport version to test against (2/3/4), e.g.
+# appraisal 4 rake          ## for ruby 2.1.2
+appraisal rake
+```
+
+
 Compatibility
 -------------
-This project is tested and compatible with REE 1.8.7, MRI 1.9.3, and MRI 2.0.0.
+This project is tested and compatible with MRI 1.9.3, JRuby 1.7.12, and MRI 2.1.2.
 
 License
 -------

data/Rakefile

@@ -1,13 +1,25 @@
+require "rubygems"
+require "bundler/setup"
 require 'rspec/core/rake_task'
-require 'rubygems/tasks'
-require 'rubygems/tasks/scm'
+unless defined?(JRUBY_VERSION)
+  require 'rubygems/tasks'
+  require 'rubygems/tasks/scm'
+  Gem::Tasks.new
+end
 require 'yard'
 
 YARD::Rake::YardocTask.new do |t|
-  t.files   = ['lib/**/*.rb']
+  t.files = ['lib/**/*.rb']
 end
 
 RSpec::Core::RakeTask.new(:spec)
-Gem::Tasks.new
+
+
+desc "Run spec with all supported versions of active support"
+task :compatibility_spec do
+  [2, 3, 4].each do |n|
+    puts `ACTIVE_SUPPORT_VERSION='~> #{n}' bundle ; rake spec`
+  end
+end
 
 task :default => :spec

data/bin/autospec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'autospec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'autospec')

data/bin/htmldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'htmldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('diff-lcs', 'htmldiff')

data/bin/ldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'ldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('diff-lcs', 'ldiff')

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/redcarpet

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'redcarpet' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('redcarpet', 'redcarpet')

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/bin/tt

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'tt' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('treetop', 'tt')

data/bin/yard

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'yard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('yard', 'yard')

data/bin/yardoc

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'yardoc' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('yard', 'yardoc')

data/bin/yri

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'yri' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('yard', 'yri')

data/lib/tms_client/client.rb

@@ -19,10 +19,12 @@ class TMS::Client
   #   client = TMS::Client.new("auth_token", {
   #                               :api_root => "https://tms.govdelivery.com",
   #                               :logger => Logger.new(STDOUT)})
-  #
+  #   client = TMS::Client.new("auth_token", {
+  #                               api_root: "https://tms.govdelivery.com",
+  #                               logger:   false})
   def initialize(auth_token, options = DEFAULTS)
     @api_root = options[:api_root]
-    @logger = options[:logger] || setup_logging(options[:debug])
+    @logger = options.fetch(:logger, setup_logging(options[:debug]))
     connect!(auth_token, options.except(:api_root, :logger, :debug))
     discover!
   end

data/lib/tms_client/errors.rb

@@ -30,7 +30,7 @@ module TMS
         super(message)
       end
     end
-    class InvalidVerb
+    class InvalidVerb < StandardError
       attr_reader :record
 
       def initialize(record_or_string)

data/lib/tms_client/instance_resource.rb

@@ -98,13 +98,16 @@ module TMS::InstanceResource
     def initialize(client, href=nil, attrs=nil)
       super(client, href)
       @attributes = {}
-      attrs ||= self.client.get(href).body if href
       set_attributes_from_hash(attrs) if attrs
     end
 
+    def attributes
+      @attributes
+    end
+
     def get
       raise TMS::Errors::InvalidGet if self.new_record?
-      process_response(client.get(self.href), :get)
+      process_response(client.get(self.href), :get) && self
     end
 
     def post

data/lib/tms_client/resource/collections.rb

@@ -63,3 +63,23 @@ end
 class TMS::CommandActions
   include TMS::CollectionResource
 end
+
+class TMS::IpawsEventCodes
+  include TMS::CollectionResource
+end
+
+class TMS::IpawsCategories
+  include TMS::CollectionResource
+end
+
+class TMS::IpawsResponseTypes
+  include TMS::CollectionResource
+end
+
+class TMS::IpawsAlerts
+  include TMS::CollectionResource
+end
+
+class TMS::IpawsNwemAreas
+  include TMS::CollectionResource
+end

data/lib/tms_client/resource/email_message.rb

@@ -1,21 +1,21 @@
 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. 
+  # 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 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. 
+  # @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!", 
+  #    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")
@@ -34,7 +34,7 @@ module TMS #:nodoc:
   #    email_message.opened.collection # => [<#EmailRecipient>,...]
   #
   # @example Using macros
-  #    email_message = client.email_messages.build(:subject => "Hello [[user]]", 
+  #    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"})
@@ -69,5 +69,13 @@ module TMS #:nodoc:
     ##
     # 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
+end

data/lib/tms_client/resource/ipaws_acknowledgement.rb

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

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

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

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

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

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

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

data/lib/tms_client/resource/ipaws_nwem_auxilary_data.rb

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

data/lib/tms_client/resource/ipaws_response_type.rb

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

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

@@ -1,10 +1,10 @@
 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. 
-  # 
+  #
+  # @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")
@@ -12,7 +12,7 @@ module TMS #:nodoc:
   #    sms.get
   class SmsMessage
     include InstanceResource
-    
+
     # @!parse attr_accessor :body
     writeable_attributes :body
 
@@ -22,5 +22,14 @@ module TMS #:nodoc:
     ##
     # 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
+end

data/lib/tms_client/resource/voice_message.rb

@@ -1,11 +1,12 @@
 module TMS #:nodoc:
   # A VoiceMessage is used to create and send a voice message to a collection of Recipient
-  # objects.  The recipients are called and the provided +play_url+ is 
-  # played to them.  Accepted sound formats include +wav+, +mp3+, and +aiff+. 
-  # 
+  # objects.  The recipients are called and the provided +play_url+ is
+  # played to them.  Accepted sound formats include +wav+, +mp3+, and +aiff+.
+  #
   #
   # @attr play_url [String] The url to the sound file to be played back to the call recipients
-  # 
+  # @attr say_text [String] A string to be read (and repeated on request) to the call recipients.
+  #
   # @example
   #    voice_message = client.voice_messages.build(:play_url => "http://example.com/emergency_weather.mp3")
   #    voice_message.recipients.build(:phone => "+18001002000")
@@ -14,8 +15,8 @@ module TMS #:nodoc:
   class VoiceMessage
     include InstanceResource
 
-    # @!parse attr_accessor :play_url
-    writeable_attributes :play_url
+    # @!parse attr_accessor :play_url, :play_url
+    writeable_attributes :play_url, :say_text
 
     # @!parse attr_reader :created_at, :completed_at, :status
     readonly_attributes :created_at, :completed_at, :status
@@ -24,8 +25,16 @@ module TMS #:nodoc:
     # 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'
+
     def self.to_s
       "VoiceMessage"
     end
   end
-end
+end

data/lib/tms_client/version.rb

@@ -1,3 +1,3 @@
 module TMS #:nodoc:
-  VERSION = "0.4.1"
+  VERSION = "0.5.1"
 end