govdelivery-tms 0.9.4 → 3.0.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    OGU2YjhiZjAxYTBmOWZjNGRiOGEzYmJmM2JiYmFhNjVkY2U4NGJmYw==
-  data.tar.gz: !binary |-
-    Y2EzNjAyZDA5MWRiZmYyYzBmMzkyZWYyYzc5NDQ1MjMwZjY1NmM5NA==
+SHA256:
+  metadata.gz: fecf72f8c754802f0f002fee9576334b534e29ca4cc0e7f5280821565912db85
+  data.tar.gz: d6e4087bcde8f26b587c4bc9a9616dae17b748a6548508adbdf1aeaa48e87136
 SHA512:
-  metadata.gz: !binary |-
-    M2ZhODFhYmQxZTZkMmI1MmU3NzA3OGNlNzFkMDlkMmQ1MTYwOWViMWNkYWRh
-    Yzg5ZDI4Y2I5ZDZlZGE1OTQyYWZkNjAxNmJkOWFmYTU1NWNjMzIxYTM1ZmUx
-    ZmI0MTA2MTMwNGIxZWI2YzlkYjQ2YzBlYWI0YjFhMGQ0MDk5NmU=
-  data.tar.gz: !binary |-
-    MmJmNzk5ZjRiNWI1OTJiNjIyYTFmMDY0MTgyZmFhZmQ1ZWQxNzA4YmZmMmU5
-    ZjZmMWUzMDUwZTJhMGY3NGQzNjE3ZTAzZjVhNmNlMGRkNGU0NDU5MTBlODUw
-    NTM0ZDE0ZDU4ZDFkODZhNWE0MzEyYmVmMWY3NTA3NzEwMzQ2ZWE=
+  metadata.gz: e0fcda1aa09326cb1761e9746032052b4d50ac5f0a08e550e64982929a63204cf1dda6c255202877384c56afafb07ed45280a3e6b159ebb8eaee0ab950588c83
+  data.tar.gz: be9073dd5b9e540c61283777ed5814d3fe6ecbb3064990decbc7f9c00b19aeb97a37bc3ae2f07f633c86890f05a48f4e99aa760afc21d534438237c67d2e83b9

data/.version

@@ -0,0 +1 @@
+3.0.0

data/Gemfile

@@ -2,8 +2,7 @@ source 'https://rubygems.org'
 gemspec
 
 group :development, :test do
-  gem 'appraisal'
-  gem 'rspec', '~> 3.2.0'
+  gem 'rspec'
   gem 'rspec-its'
   gem 'rake'
   gem 'redcarpet', platform: :ruby

data/README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://travis-ci.org/govdelivery/govdelivery-tms-ruby.svg?branch=master)](https://travis-ci.org/govdelivery/govdelivery-tms-ruby)
+[![Build Status](https://travis-ci.org/granicus/govdelivery-tms-ruby.svg?branch=master)](https://travis-ci.org/granicus/govdelivery-tms-ruby)
 
 TMS Client
 ===========
@@ -39,6 +39,27 @@ client.sms_messages.get        # get the first page of sms messages
 client.sms_messages.next.get   # get the next page of sms messages
 ```
 
+#### Optional parameters
+When loading messages, the following parameters can be passed with requests to change the sort order and number of results returned:
+
+**page_size**: Must be an integer between 1 and 100
+
+```ruby
+client.sms_messages.get({page_size: 2})                            # get the first two sms messages
+```
+
+**sort_by**: Field by which to sort results. Default: created_at.
+
+```ruby
+client.sms_messages.get({sort_by: 'created_at'})                  # get the first page of sms messages, sorted by created_at
+```
+
+**sort_order**: Order by which to sort results. Must be ASC or DESC. Default: DESC.
+
+```ruby
+client.sms_messages.get({sort_order: 'ASC'})                      # get the first page of sms messages, sorted by created_at DESC
+client.sms_messages.get({sort_by: 'body', sort_order: 'ASC'})     # get the first page of sms messages, sorted by body ASC
+```
 
 ### Sending an SMS Message
 
@@ -68,8 +89,7 @@ inbound_sms.attributes                                      # {:from=>"+15005550
 
 ```ruby
 message = client.email_messages.build(:body=>'<p><a href="http://example.com">Visit here</a></p>',
-                                      :subject => 'Hey',
-                                      :from_email => 'foo@example.com')
+                                      :subject => 'Hey')
 message.recipients.build(:email=>'example1@example.com')
 message.recipients.build(:email=>'')
 message.post             # true
@@ -91,6 +111,45 @@ message.recipients.build(:email=>'bill@example.com')
 message.post
 ```
 
+#### From Addresses
+
+From Addresses are read only resources that define which email addresses you
+can send an email from and have replies and bounces sent to. From Addresses
+also have an associated default display name. If you wish to send a message
+from an address that is not your account's default, you will need to specify a
+From Address on your Message.
+
+To add or edit From Addresses, you will need to contact your CSC.
+
+```ruby
+# Fetch the from_addresses on your account
+client.from_addresses.get
+
+# Get the first from address on your account
+from_address = client.from_addresses.collection.first
+
+# Lets see what the emails and display name are
+puts from_address.from_email
+puts from_address.reply_to_email
+puts from_address.bound_email
+puts from_address.from_name
+
+# Is this from address the account's default?
+puts from_address.is_default
+
+# New messages default to using the default from_address of your account
+message = client.email_messages.build(:body=>'<p><a href="http://example.com">Visit here</a></p>',
+                                      :subject => 'Hey')
+
+# Specifiy a different from_address using the links hash
+message.links[:from_address] = from_address.id
+
+# If you want, you can override the form_name on a message
+message.from_name = 'Better Name'
+message.post
+```
+
+
 ### Creating an Email Template
 
 ```ruby
@@ -181,6 +240,7 @@ completed_at  |  (sent or failed recipients only)
 
 Metrics
 -------
+
 ### Viewing recipients that clicked on a link in an email
 
 ```ruby
@@ -205,6 +265,29 @@ email_recipient.clicks.get.collection #=> [<#EmailRecipientClick>,...]
 email_recipient.opens.get.collection #=> [<#EmailRecipientOpen>,...]
 ```
 
+Reports
+-------
+
+### Message recipient counts
+Recipient counts are aggregated across all messages and grouped by message status.
+
+`start` and `end` are required datetime parameters. They must be truncated to the hour and be in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).
+
+End dates are exclusive and all results are based on utc time.
+
+#### Email
+
+```ruby
+stats = client.reports_messages_email_statistics.get({start: '2017-06-01T10:00:00Z', end: '2017:06:30T18:00:00Z'})     # get email recipient counts for messages sent between 6/1/17 and 6/30/17
+stats.recipients
+```
+
+#### SMS
+```ruby
+stats = client.reports_messages_sms_statistics.get({start: '2017-06-01T10:00:00Z', end: '2017:06:30T18:00:00Z'})      # get sms recipient counts for messages sent between 6/1/17 and 6/30/17
+stats.recipients
+```
+
 Configuring 2-way SMS
 ---------------------
 
@@ -321,25 +404,22 @@ 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:
 
-```ruby
+```
 # install development gems
 bundle install
 # generate documentation
-rake yard
+bundle exec 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 (3/4), e.g.
-# appraisal 4 rake          ## for ruby 2.1.2
-appraisal rake
 ```
-
+bundle install
+bundle exec rake
+```
 
 Compatibility
 -------------
-This project is tested and compatible with MRI 1.9.3, JRuby 1.7.12, and MRI 2.1.2.
+This project is tested and compatible with Ruby >=2.5.8, and <= 2.7.1.

data/govdelivery-tms.gemspec

@@ -12,18 +12,21 @@ Gem::Specification.new do |s|
   s.summary     = 'A ruby client to interact with the GovDelivery TMS REST API.'
   s.description = "A reference implementation, written in Ruby,
                      to interact with GovDelivery's TMS API. The client is
-                     compatible with Ruby 1.9 and 2.0. "
+                     compatible with Ruby >=2.5.8, and <= 2.7.1"
 
-  s.add_runtime_dependency 'activesupport'
+  s.add_runtime_dependency 'activesupport', '>=5.2.4.3', '<6.0.0'
   s.add_runtime_dependency 'faraday'
   s.add_runtime_dependency 'faraday_middleware'
   s.add_runtime_dependency 'mime-types'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'simplecov-cobertura'
 
   s.files       = %w(
     Gemfile
     README.md
     Rakefile
     govdelivery-tms.gemspec
+    .version
   ) + Dir['lib/**/*']
 
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/govdelivery-tms.rb

@@ -36,3 +36,5 @@ require 'govdelivery/tms/resource/command_action'
 require 'govdelivery/tms/resource/command'
 require 'govdelivery/tms/resource/keyword'
 require 'govdelivery/tms/resource/webhook'
+require 'govdelivery/tms/resource/reports_messages_email_statistics'
+require 'govdelivery/tms/resource/reports_messages_sms_statistics'

data/lib/govdelivery/tms/client.rb

@@ -39,8 +39,8 @@ class GovDelivery::TMS::Client
     parse_links(services['_links'])
   end
 
-  def get(href)
-    response = raw_connection.get(href)
+  def get(href, params = {})
+    response = raw_connection.get(href, params)
     case response.status
     when 500..599
       fail GovDelivery::TMS::Request::Error.new(response.status)

data/lib/govdelivery/tms/collection_resource.rb

@@ -16,8 +16,8 @@ module GovDelivery::TMS::CollectionResource
       end
     end
 
-    def get
-      response = client.get(href)
+    def get(params = {})
+      response = client.get(href, params)
       initialize_collection_from_items(response.body)
       # setup page links from header
       links = LinkHeader.parse(response.headers['link']).to_a.collect do |a|

data/lib/govdelivery/tms/connection.rb

@@ -1,8 +1,8 @@
 class GovDelivery::TMS::Connection
   attr_accessor :auth_token, :api_root, :connection, :logger
 
-  def get(href)
-    resp = connection.get("#{href}.json")
+  def get(href, params = {})
+    resp = connection.get("#{href}.json", params)
     if resp.status != 200
       fail RecordNotFound.new("Could not find resource at #{href} (status #{resp.status})")
     else

data/lib/govdelivery/tms/instance_resource.rb

@@ -130,9 +130,9 @@ module GovDelivery::TMS::InstanceResource
 
     attr_reader :attributes
 
-    def get
+    def get(params={})
       fail GovDelivery::TMS::Errors::InvalidGet if self.new_record?
-      process_response(client.get(href), :get) && self
+      process_response(client.get(href, params), :get) && self
     end
     alias_method :get!, :get
 

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

@@ -1,11 +1,23 @@
 module GovDelivery::TMS #:nodoc:
+  # FromAddress is an email address, associated response addresses (reply to,
+  # error to), and a display name that is used when sending an email via TMS.
+  # All messages sent via TMS must have a FromAddress, which can be set via or
+  # via a template. If neither is set with a message is sent, then the account's
+  # default FromAddress will be used.
+  #
+  # This resource is read-only.
+  #
+  # To add more FromAddresses to your account, please contact your CSC.
+  #
+  # @attr from_email [String] Email address that a message will be sent from
+  # @attr from_name [String] Display name of the sender of a message
+  # @attr reploy_to_email [Stirng] Email address that will be used for the Reply-To header
+  # @attr bounce_email [String] Email address that will be used for the Errors-To header
+  # @attr is_default [Boolean] Indicates if the FromAddress is the account's default FromAddress
   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
-
     # @!parse attr_reader :id, :created_at
-    readonly_attributes :id, :created_at
+    readonly_attributes :id, :created_at, :from_email, :from_name, :reply_to_email, :bounce_email, :is_default
   end
 end

data/lib/govdelivery/tms/resource/reports_messages_email_statistics.rb

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

data/lib/govdelivery/tms/resource/reports_messages_sms_statistics.rb

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

data/lib/govdelivery/tms/util/core_ext.rb

@@ -5,8 +5,10 @@ module GovDelivery::TMS::CoreExt
     ActiveSupport::Inflector.demodulize(path)
   end
 
-  def classify(str)
-    ActiveSupport::Inflector.camelize(str)
+  def camelize(str)
+    # Do not use ActiveSupport::Inflector.camelize because it uses global
+    # ActiveSupport::Inflector.acronum data.
+    str.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
   end
 
   def singularize(str)

data/lib/govdelivery/tms/util/hal_link_parser.rb

@@ -38,7 +38,7 @@ module GovDelivery::TMS::Util
     end
 
     def relation_class(rel)
-      ::GovDelivery::TMS.const_get(classify(rel)).tap do |klass|
+      ::GovDelivery::TMS.const_get(camelize(rel)).tap do |klass|
         return nil unless klass.name =~ /GovDelivery::TMS/
       end
     rescue NameError

data/lib/govdelivery/tms/version.rb

@@ -1,5 +1,5 @@
 module GovDelivery
   module TMS #:nodoc:
-    VERSION = '0.9.4'.freeze
+    VERSION = File.read(File.join(__dir__, "../../../.version")).freeze
   end
 end

data/spec/client_spec.rb

@@ -52,6 +52,11 @@ describe GovDelivery::TMS::Client do
       allow(@raw_connection).to receive(:get).and_return(double('response', status: 202, body: { 'message' => 'hi' }))
       expect { @client.get('/blargh') }.to raise_error(GovDelivery::TMS::Request::InProgress)
     end
+    it 'should handle all other responses' do
+      response = double('response', status: 200, body: { 'message' => 'hi' })
+      allow(@raw_connection).to receive(:get).with('/blargh', {params: 'foobar'}).and_return(response)
+      expect(@client.get('/blargh', {params: 'foobar'})).to eq(response)
+    end
 
     context 'creating a new client without output' do
       subject { GovDelivery::TMS::Client.new('auth_token', api_root: 'null_url', logger: false) }

data/spec/core_ext_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+def inflector
+  m = ActiveSupport::Inflector.method('inflections')
+  return ActiveSupport::Inflector.inflections(:en) if m.arity == 1
+  ActiveSupport::Inflector.inflections
+end
+
+describe GovDelivery::TMS::CoreExt do
+
+  subject do
+    Object.new.extend(described_class)
+  end
+
+  describe '#camelize' do
+    before do
+      inflector do |inflect|
+        inflect.acronym 'SMS'
+      end
+    end
+
+    it 'should return camilized string not using inflector acronyms' do
+      expect(subject.camelize('sms_message')).to eq 'SmsMessage'
+    end
+  end
+
+end

data/spec/email_message_spec.rb

@@ -91,7 +91,7 @@ describe GovDelivery::TMS::EmailMessage do
                                      'message_type' => '/message_type/abc',
                                      'email_template' => '/templates/email/new-template' }
                   }
-      expect(@message.client).to receive('get').with(@message.href).and_return(double('response', status: 200, body: response))
+      expect(@message.client).to receive('get').with(@message.href, {}).and_return(double('response', status: 200, body: response))
       @message.get
       expect(@message.body).to eq('processed')
       expect(@message.subject).to eq('hey')

data/spec/email_messages_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe GovDelivery::TMS::EmailMessages do
+  let(:href) {'/messages/email'}
+  context 'loading messages' do
+    let(:client) {double('client')}
+    let(:messages) {[
+        { subject: 'hello', body: 'greetings from places', created_at: 'a while ago' },
+        { subject: 'hi!', body: 'feel me flow', created_at: 'longer ago' },
+        { subject: 'yo', body: 'I am not a robot', created_at: 'even longer ago' }
+        ]}
+    
+    before do
+      @messages = GovDelivery::TMS::EmailMessages.new(client, href)
+    end
+    
+    it 'should GET ok' do
+      expect(@messages.client).to receive(:get).and_return(double('response', body: messages, status: 200, headers: { 'link' => "</messages/email/page/2>; rel=\"next\",</messages/email/page/11>; rel=\"last\"" }))
+
+      @messages.get
+      expect(@messages.collection.length).to eq(3)
+      expect(@messages.next.href).to eq('/messages/email/page/2')
+      expect(@messages.last.href).to eq('/messages/email/page/11')
+    end
+    
+    it 'should GET ok with parameters' do      
+      params = {page_size: 2, sort_by: 'created_by', sort_order: 'foobar'}
+      expect(@messages.client).to receive(:get).with(href, params).and_return(double('response', body: messages[1..-1], status: 200, headers: { 'link' => "</messages/email/page/2>; rel=\"next\",</messages/email/page/11>; rel=\"last\"" }))
+
+      @messages.get(params)
+      expect(@messages.collection.length).to eq(2)
+    end
+  end
+end

data/spec/email_template_spec.rb

@@ -25,7 +25,7 @@ describe GovDelivery::TMS::EmailTemplate do
         }
       ]
 
-      expect(@templates.client).to receive('get').with('/templates/email').and_return(double('response', status: 200, body: response, headers: {}))
+      expect(@templates.client).to receive('get').with('/templates/email', {}).and_return(double('response', status: 200, body: response, headers: {}))
       @templates.get
       expect(@templates.collection.length).to eq(1)
     end

data/spec/from_address_spec.rb

@@ -12,6 +12,7 @@ describe GovDelivery::TMS::FromAddress do
     it 'should be able to get a list of email templates' do
       response = [{
         'from_email'      => 'something@evotest.govdelivery.com',
+        'from_name'       => 'Something',
         'reply_to_email'  => 'something@evotest.govdelivery.com',
         'bounce_email'    => 'something@evotest.govdelivery.com',
         'is_default'      => true,
@@ -20,43 +21,12 @@ describe GovDelivery::TMS::FromAddress do
         '_links'          => { 'self' => '/from_addresses/1' }
       }]
 
-      expect(@fromaddresses.client).to receive('get').with('/from_addresses').and_return(double('/from_addresses', status: 200, body: response, headers: {}))
+      expect(@fromaddresses.client).to receive('get').with('/from_addresses',{}).and_return(double('/from_addresses', status: 200, body: response, headers: {}))
       addresses = @fromaddresses.get
       expect(addresses.collection.length).to eq(1)
       expect(addresses.collection.first.class).to eq(GovDelivery::TMS::FromAddress)
       expect(addresses.collection.first.from_email).to eq('something@evotest.govdelivery.com')
-    end
-  end
-
-  context 'creating a from address' do
-    let(:client) do
-      double('client')
-    end
-
-    before do
-      @fromaddress = GovDelivery::TMS::FromAddress.new(client, '/from_addresses',            from_email:      'something@evotest.govdelivery.com',
-                                                                                             reply_to_email:  'something@evotest.govdelivery.com',
-                                                                                             bounce_email:    'something@evotest.govdelivery.com',
-                                                                                             is_default:      true)
-    end
-
-    it 'should post successfully' do
-      response = {
-        'from_email'      => 'something@evotest.govdelivery.com',
-        'reply_to_email'  => 'something@evotest.govdelivery.com',
-        'bounce_email'    => 'something@evotest.govdelivery.com',
-        'is_default'      => true,
-        'created_at'      => 'sometime',
-        '_links'          => { 'self' => '/from_addresses/1' }
-      }
-      expect(@fromaddress.client).to receive('post').with(@fromaddress).and_return(double('response', status: 201, body: response))
-      @fromaddress.post
-      expect(@fromaddress.from_email).to eq('something@evotest.govdelivery.com')
-      expect(@fromaddress.reply_to_email).to eq('something@evotest.govdelivery.com')
-      expect(@fromaddress.bounce_email).to eq('something@evotest.govdelivery.com')
-      expect(@fromaddress.is_default).to eq(true)
-      expect(@fromaddress.created_at).to eq('sometime')
-      expect(@fromaddress.href).to eq('/from_addresses/1')
+      expect(addresses.collection.first.from_name).to eq('Something')
     end
   end
 

data/spec/keyword_spec.rb

@@ -39,7 +39,7 @@ describe GovDelivery::TMS::Keyword do
     end
     it 'should GET cleanly' do
       response = { name: 'FOO', response_text: 'hello' }
-      expect(@keyword.client).to receive('get').with(@keyword.href).and_return(double('response', status: 200, body: response))
+      expect(@keyword.client).to receive('get').with(@keyword.href, {}).and_return(double('response', status: 200, body: response))
       @keyword.get
       expect(@keyword.name).to eq('FOO')
       expect(@keyword.response_text).to eq('hello')

data/spec/reports_messages_email_statistics_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe GovDelivery::TMS::ReportsMessagesEmailStatistics do
+  context 'loading email message statistics' do
+    let(:client) { double('client') }
+    let(:href) { '/reports/messages/email/statistics' }
+
+    before do
+      @statistics = GovDelivery::TMS::ReportsMessagesEmailStatistics.new(client, href, {})
+    end
+
+    it 'gets OK with params' do
+      params = {start: Time.now.beginning_of_hour - 7.days, end: Time.now.beginning_of_hour}
+      stats = {:recipients => {:new => 5, :sending => 3, :inconclusive => 2, :blacklisted => 1, :canceled => 7, :sent => 80, :failed => 2} }
+
+
+      expect(@statistics.client).to receive('get').with(href, params).and_return(double('response', status: 200, body: stats))
+      @statistics.get(params)
+      expect(@statistics.recipients).to eq(stats[:recipients])
+      expect(@statistics.recipients[:sent]).to eq(80)
+    end
+  end
+end

data/spec/reports_messages_sms_statistics_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe GovDelivery::TMS::ReportsMessagesSmsStatistics do
+  context 'loading sms message statistics' do
+    let(:client) { double('client') }
+    let(:href) { '/reports/messages/sms/statistics' }
+
+    before do
+      @statistics = GovDelivery::TMS::ReportsMessagesSmsStatistics.new(client, href, {})
+    end
+
+    it 'gets OK with params' do
+      params = {start: Time.now.beginning_of_hour - 7.days, end: Time.now.beginning_of_hour}
+      stats = {:recipients => {:new => 5, :sending => 3, :inconclusive => 2, :blacklisted => 1, :canceled => 7, :sent => 80, :failed => 2} }
+
+      expect(@statistics.client).to receive('get').with(href, params).and_return(double('response', status: 200, body: stats))
+      @statistics.get(params)
+      expect(@statistics.recipients).to eq(stats[:recipients])
+      expect(@statistics.recipients[:sent]).to eq(80)
+    end
+  end
+end

data/spec/sms_message_spec.rb

@@ -52,7 +52,7 @@ describe GovDelivery::TMS::SmsMessage do
     end
     it 'should GET cleanly' do
       response = { body: 'processed', recipients: [{ phone: '22345678' }], created_at: 'time' }
-      expect(@message.client).to receive('get').with(@message.href).and_return(double('response', status: 200, body: response))
+      expect(@message.client).to receive('get').with(@message.href, {}).and_return(double('response', status: 200, body: response))
       @message.get
       expect(@message.body).to eq('processed')
       expect(@message.created_at).to eq('time')

data/spec/sms_messages_spec.rb

@@ -1,21 +1,33 @@
 require 'spec_helper'
 
 describe GovDelivery::TMS::SmsMessages do
+  let(:href) {'/messages/sms'}
   context 'creating a new messages list' do
-    let(:client) do
-      double('client')
-    end
+    let(:client) {double('client')}
+    let(:messages) {[
+      { short_body: 'hi ho', created_at: 'a while ago' },
+      { short_body: 'hello', created_at: 'longer ago' },
+      { short_body: 'yo', created_at: 'even longer ago' }
+      ]}
+
     before do
-      @messages = GovDelivery::TMS::SmsMessages.new(client, '/messages')
+      @messages = GovDelivery::TMS::SmsMessages.new(client, href)
     end
     it 'should GET itself' do
-      body = [{ short_body: 'hi ho', created_at: 'a while ago' }, { short_body: 'feel me flow', created_at: 'longer ago' }]
-      expect(@messages.client).to receive(:get).and_return(double('response', body: body, status: 200, headers: { 'link' => "</messages/page/2>; rel=\"next\",</messages/page/11>; rel=\"last\"" }))
+      expect(@messages.client).to receive(:get).and_return(double('response', body: messages, status: 200, headers: { 'link' => "</messages/sms/page/2>; rel=\"next\",</messages/sms/page/11>; rel=\"last\"" }))
 
       @messages.get
+      expect(@messages.collection.length).to eq(3)
+      expect(@messages.next.href).to eq('/messages/sms/page/2')
+      expect(@messages.last.href).to eq('/messages/sms/page/11')
+    end
+
+    it 'should GET ok with parameters' do
+      params = {page_size: 2, sort_by: 'created_by', sort_order: 'foobar'}
+      expect(@messages.client).to receive(:get).with(href, params).and_return(double('response', body: messages[1..-1], status: 200, headers: { 'link' => "</messages/sms/page/2>; rel=\"next\",</messages/sms/page/11>; rel=\"last\"" }))
+
+      @messages.get(params)
       expect(@messages.collection.length).to eq(2)
-      expect(@messages.next.href).to eq('/messages/page/2')
-      expect(@messages.last.href).to eq('/messages/page/11')
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,4 +1,11 @@
 $LOAD_PATH << File.expand_path('../lib', __FILE__)
+
+require 'simplecov'
+require 'simplecov-cobertura'
+
+SimpleCov.formatter = SimpleCov::Formatter::CoberturaFormatter
+SimpleCov.start { add_filter "/spec/" }
+
 require 'govdelivery-tms'
 
 class GovDelivery::TMS::Horse

metadata

@@ -1,80 +1,116 @@
 --- !ruby/object:Gem::Specification
 name: govdelivery-tms
 version: !ruby/object:Gem::Version
-  version: 0.9.4
+  version: 3.0.0
 platform: ruby
 authors:
 - GovDelivery
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-06-03 00:00:00.000000000 Z
+date: 2020-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.2.4.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.2.4.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: simplecov-cobertura
+  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 reference implementation, written in Ruby,\n                     to
-  interact with GovDelivery's TMS API. The client is\n                     compatible
-  with Ruby 1.9 and 2.0. "
+description: |-
+  A reference implementation, written in Ruby,
+                       to interact with GovDelivery's TMS API. The client is
+                       compatible with Ruby >=2.5.8, and <= 2.7.1
 email:
 - support@govdelivery.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".version"
 - Gemfile
 - README.md
 - Rakefile
@@ -103,6 +139,8 @@ files:
 - lib/govdelivery/tms/resource/keyword.rb
 - lib/govdelivery/tms/resource/message_type.rb
 - lib/govdelivery/tms/resource/recipient.rb
+- lib/govdelivery/tms/resource/reports_messages_email_statistics.rb
+- lib/govdelivery/tms/resource/reports_messages_sms_statistics.rb
 - lib/govdelivery/tms/resource/sms_message.rb
 - lib/govdelivery/tms/resource/sms_template.rb
 - lib/govdelivery/tms/resource/webhook.rb
@@ -111,7 +149,9 @@ files:
 - lib/govdelivery/tms/version.rb
 - spec/client_spec.rb
 - spec/command_types_spec.rb
+- spec/core_ext_spec.rb
 - spec/email_message_spec.rb
+- spec/email_messages_spec.rb
 - spec/email_template_spec.rb
 - spec/errors_spec.rb
 - spec/from_address_spec.rb
@@ -121,6 +161,8 @@ files:
 - spec/keywords_spec.rb
 - spec/mail/delivery_method_spec.rb
 - spec/message_types_spec.rb
+- spec/reports_messages_email_statistics_spec.rb
+- spec/reports_messages_sms_statistics_spec.rb
 - spec/sms_message_spec.rb
 - spec/sms_messages_spec.rb
 - spec/spec_helper.rb
@@ -128,30 +170,32 @@ files:
 homepage: http://govdelivery.com
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 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.4.6
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.7.6.2
+signing_key:
 specification_version: 4
 summary: A ruby client to interact with the GovDelivery TMS REST API.
 test_files:
 - spec/client_spec.rb
 - spec/command_types_spec.rb
+- spec/core_ext_spec.rb
 - spec/email_message_spec.rb
+- spec/email_messages_spec.rb
 - spec/email_template_spec.rb
 - spec/errors_spec.rb
 - spec/from_address_spec.rb
@@ -161,8 +205,9 @@ test_files:
 - spec/keywords_spec.rb
 - spec/mail/delivery_method_spec.rb
 - spec/message_types_spec.rb
+- spec/reports_messages_email_statistics_spec.rb
+- spec/reports_messages_sms_statistics_spec.rb
 - spec/sms_message_spec.rb
 - spec/sms_messages_spec.rb
 - spec/spec_helper.rb
 - spec/tms_spec.rb
-has_rdoc: