tms_client 0.5.1 → 0.5.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 28f2987f06ad23d327d06b2d38eb054259045dd6
+  data.tar.gz: 76870cb343e8a97e0303908a24191cea6bb9915b
+SHA512:
+  metadata.gz: 4d2e771630e5b9f77af2edf27a5ed9276d1ebced7d8f47cd74ff660088aa09dc03176cb73a26d525e41be72171e18b293852519abf827c88812670a36a9c5860
+  data.tar.gz: d0263120ec36f712428cc97de967153c4706ee5610560cf8cabfecf5680e1bc8f4bbd7bf9fae02f61b4b275f05b29cabdeade2b212a82b267eec9d5370d39c17

data/README.md

@@ -1,3 +1,5 @@
+[![Build Status](https://travis-ci.org/govdelivery/tms_client.svg?branch=master)](https://travis-ci.org/govdelivery/tms_client)
+
 TMS Client 
 ===========
 This is a reference Ruby client to interact with the GovDelivery TMS REST API.
@@ -22,6 +24,7 @@ Connecting
 Loading an instance of `TMS::Client` will automatically connect to the API to query the available resources for your account.
 
 ```ruby
+# default api root endpoint is https://tms.govdelivery.com
 client = TMS::Client.new('auth_token', :api_root => 'https://stage-tms.govdelivery.com')
 ```
 
@@ -111,6 +114,29 @@ alert.post # true
 alert.ipaws_response # { "identifier"=>"CAP12-TEST-1397743203", "statuses"=> [{"CHANNELNAME"=>"CAPEXCH" ... }]}
 ```
 
+
+Webhooks
+-------
+### POST to a URL when a recipient is blacklisted (i.e. to remove from your list)  
+    
+
+```ruby
+webhook = client.webhooks.build(:url=>'http://your.url', :event_type=>'blacklisted')
+webhook.post # true
+```
+
+POSTs will include in the body the following attributes:
+
+  attribute   |  description
+------------- | -------------
+message_type  | 'sms', 'email', or 'voice'
+status:       |  message state
+recipient_url |  recipient URL
+messsage_url  |  message URL 
+error_message |  (failures only)
+completed_at  |  (sent or failed recipients only)
+
+
 Metrics
 -------
 ### Viewing recipients that clicked on a link in an email

data/lib/tms_client/client.rb

@@ -71,7 +71,7 @@ class TMS::Client
   def delete(href)
     response = raw_connection.delete(href)
     case response.status
-      when 200
+      when 200...299
         return response
       else
         raise TMS::Request::Error.new(response.status)

data/lib/tms_client/instance_resource.rb

@@ -5,6 +5,8 @@ module TMS::InstanceResource
     base.send(:include, InstanceMethods)
   end
 
+  attr_accessor :response
+
   module ClassMethods
     ##
     # Writeable attributes are sent on POST/PUT.
@@ -149,6 +151,7 @@ module TMS::InstanceResource
     end
 
     def process_response(response, method)
+      self.response = response
       error_class = TMS::Errors.const_get("Invalid#{method.to_s.capitalize}")
       case response.status
         when 204

data/lib/tms_client/resource/collections.rb

@@ -83,3 +83,7 @@ end
 class TMS::IpawsNwemAreas
   include TMS::CollectionResource
 end
+
+class TMS::Webhooks
+  include TMS::CollectionResource
+end

data/lib/tms_client/resource/webhook.rb

@@ -0,0 +1,20 @@
+module TMS #:nodoc:
+  #  A Webhook gets invoked when a recipient enters a queued or final state
+  #
+  # @attr url [String] The URL to POST webhooks to
+  # @attr event_type  'sending', 'inconclusive', 'blacklisted', 'sent', 'canceled', or 'failed'
+  #
+  # @example
+  #    webhook = client.webhooks.build(:url => 'http://your.url', :event_type => 'failed')
+  #    webhook.post
+  #    webhook.get
+  class Webhook
+    include InstanceResource
+
+    # @!parse attr_accessor :url, :event_type
+    writeable_attributes :url, :event_type
+
+    # @!parse attr_reader :created_at, :updated_at
+    readonly_attributes :created_at, :updated_at
+  end
+end

data/lib/tms_client/util/hal_link_parser.rb

@@ -1,10 +1,6 @@
 module TMS::Util
   module HalLinkParser
 
-    #def self.included(base)
-    #  base.send(:include, TMS::CoreExt)
-    #end
-
     def parse_links(_links)
       @resources = {}
       return if _links.nil?

data/lib/tms_client/version.rb

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

data/lib/tms_client.rb

@@ -39,3 +39,4 @@ require 'tms_client/resource/ipaws_cog_profile'
 require 'tms_client/resource/ipaws_nwem_authorization'
 require 'tms_client/resource/ipaws_nwem_area'
 require 'tms_client/resource/ipaws_alert'
+require 'tms_client/resource/webhook'

metadata

@@ -1,65 +1,58 @@
 --- !ruby/object:Gem::Specification
 name: tms_client
 version: !ruby/object:Gem::Version
-  version: 0.5.1
-  prerelease: 
+  version: 0.5.2
 platform: ruby
 authors:
 - GovDelivery
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-06 00:00:00.000000000 Z
+date: 2014-09-10 00:00:00.000000000 Z
 dependencies:
 - !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'
 - !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'
-description: ! "A reference implementation, written in Ruby, \n                     to
+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:
@@ -81,7 +74,17 @@ files:
 - Gemfile
 - README.md
 - Rakefile
-- tms_client.gemspec
+- bin/autospec
+- bin/htmldiff
+- bin/ldiff
+- bin/rake
+- bin/redcarpet
+- bin/rspec
+- bin/tt
+- bin/yard
+- bin/yardoc
+- bin/yri
+- lib/tms_client.rb
 - lib/tms_client/base.rb
 - lib/tms_client/client.rb
 - lib/tms_client/collection_resource.rb
@@ -114,10 +117,10 @@ files:
 - lib/tms_client/resource/recipient.rb
 - lib/tms_client/resource/sms_message.rb
 - lib/tms_client/resource/voice_message.rb
+- lib/tms_client/resource/webhook.rb
 - lib/tms_client/util/core_ext.rb
 - lib/tms_client/util/hal_link_parser.rb
 - lib/tms_client/version.rb
-- lib/tms_client.rb
 - spec/client_spec.rb
 - spec/command_types_spec.rb
 - spec/email_message_spec.rb
@@ -138,45 +141,29 @@ files:
 - spec/tms_client_spec.rb
 - spec/voice_message_spec.rb
 - spec/voice_messages_spec.rb
-- bin/autospec
-- bin/htmldiff
-- bin/ldiff
-- bin/rake
-- bin/redcarpet
-- bin/rspec
-- bin/tt
-- bin/yard
-- bin/yardoc
-- bin/yri
+- tms_client.gemspec
 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'
-      segments:
-      - 0
-      hash: -3231966882544892365
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3231966882544892365
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23.2
+rubygems_version: 2.2.2
 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