govdelivery-tms 0.10.1 → 2.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 80ce30c67675cf5ca2fd17540de4ec441ca4f5eb
-  data.tar.gz: f687a66bd95d9ea853118833ecd7b22b1d8664a5
+SHA256:
+  metadata.gz: d64e10030da0d761968107c6c275bc7605428dcdc9080c0dbec58c1eafb4358d
+  data.tar.gz: 7e9566ed9d64e80e3b50ef48cd1b8a00a434882afcd888472a9e1f5e589eed43
 SHA512:
-  metadata.gz: a7d601b3087a473619bb61b51ebeedec2e6b8f1a71eeb63ed3e81fe01bf04c6b3694c7adbdb55ab12bfc76f25c03cac1631f97fb78f24cd6e2a1659cfb4a51ff
-  data.tar.gz: e69055850da82be3a98a87510bdc6619c8be93f08123a77c3d9469d563bd5f079d2ad69219e2c5ca3e17544d457fee778fff0f20dce81d47e0bc37d4fdbe2987
+  metadata.gz: 43b1065b7a69d3984fb106b088d55d77c67d4a97994616d2010f0086d957f79b69e1c0030e33fd4e4c78a2b59ea4088a7e51dbd3ff579f4d25f753db6156d93b
+  data.tar.gz: 41be63bb2424563b899838ec5b2b76eee1bede37ee63a5194aef1c16cb8b8e2a891bb1bd6c35d925877350d0515cefb58a919529f00351b4f8202de82c2e1b67

data/Gemfile

@@ -3,7 +3,7 @@ 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

@@ -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
 
@@ -219,6 +240,7 @@ completed_at  |  (sent or failed recipients only)
 
 Metrics
 -------
+
 ### Viewing recipients that clicked on a link in an email
 
 ```ruby
@@ -243,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
 ---------------------
 
@@ -359,22 +404,37 @@ 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
+This project relies upon the appraisal gem to support running tests with different ActiveSupport versions.
+
+### default ActiveSupport
+```
+bundle exec appraisal install
+bundle exec appraisal rake
+```
+
+### ActiveSupport 3
+```
+bundle update
+bundle install --gemfile gemfiles/3.gemfile
+bundle exec appraisal 3 rake
+```
+
+### ActiveSupport 4
+```
+bundle update
+bundle install --gemfile gemfiles/4.gemfile
+bundle exec appraisal 4 rake
 ```
 
 

data/govdelivery-tms.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'activesupport'
   s.add_runtime_dependency 'faraday'
   s.add_runtime_dependency 'faraday_middleware'
-  s.add_runtime_dependency 'mime-types', ['< 3.0']
+  s.add_runtime_dependency 'mime-types'
 
   s.files       = %w(
     Gemfile

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/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/version.rb

@@ -1,5 +1,5 @@
 module GovDelivery
   module TMS #:nodoc:
-    VERSION = '0.10.1'.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

@@ -1,5 +1,11 @@
 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
@@ -7,10 +13,13 @@ describe GovDelivery::TMS::CoreExt do
   end
 
   describe '#camelize' do
-    it 'should return camilized string not using inflector acronyms' do
-      ActiveSupport::Inflector.inflections(:en) do |inflect|
+    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

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

@@ -21,7 +21,7 @@ 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)

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

metadata

@@ -1,74 +1,74 @@
 --- !ruby/object:Gem::Specification
 name: govdelivery-tms
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 2.8.3
 platform: ruby
 authors:
 - GovDelivery
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-05-18 00:00:00.000000000 Z
+date: 2018-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  name: activesupport
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  name: faraday
   prerelease: false
+  type: :runtime
   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
+  name: faraday_middleware
   prerelease: false
+  type: :runtime
   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: '3.0'
-  type: :runtime
+        version: '0'
+  name: mime-types
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.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. "
+        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. "
 email:
 - support@govdelivery.com
 executables: []
@@ -103,6 +103,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
@@ -113,6 +115,7 @@ files:
 - 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
@@ -122,6 +125,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
@@ -129,7 +134,7 @@ files:
 homepage: http://govdelivery.com
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -144,9 +149,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.6.13
+signing_key:
 specification_version: 4
 summary: A ruby client to interact with the GovDelivery TMS REST API.
 test_files:
@@ -154,6 +159,7 @@ test_files:
 - 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
@@ -163,6 +169,8 @@ 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