tms_client 0.5.3 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 740e4fe3e5d3a7641f97b2375077d7da15c15770
-  data.tar.gz: 91eb64507a4f94d0238f8a56cd915fdc7fbc8b62
+  metadata.gz: 02afad05a776d7326b6573004c848150c0f388c8
+  data.tar.gz: 45c99c89f356a0842fbd80f18df3ecf21b688d0d
 SHA512:
-  metadata.gz: f7aeff2e142de5e638f6369e3730df7182b70f64ffec8c3a96456c5cbb0f29b7e96224c612fa0af599b2318f2e63c3e35a875a8130eff0ca5beb54855dfda370
-  data.tar.gz: 852af2b4dbe19ef2f4548f17c3f957b6d4d73747f137998832854f9087059a26f42a299586e2814a4e46162977a3b53fea7aa95008041df6eb9a81add9cef7fb
+  metadata.gz: bb4937fc8493d31a08feecf5f3f0dab9df3b0636b8a16a550c27aaf764ee455de667dc5da02fad2ffea0cc0b1687509b6ebf0a8382eee7622e9ae49cb1459403
+  data.tar.gz: cc6e3ccba576297991870a2b7ab093f382ada809e71d9acb106d3559f7cd60fc946ca13dde1a1466e67507bcca47b11e7a0bb3858f83b6682cfcd64c82e0ccea

data/README.md

@@ -54,6 +54,16 @@ message.href             # "/messages/sms/87"
 message.get              # <TMS::SmsMessage href=/messages/sms/87 attributes={...}>
 ```
 
+### Retrieving Inbound SMS Messages
+```ruby
+client.inbound_sms_messages.get                             # <TMS::InboundSmsMessages href=/inbound/sms attributes={...}>
+inbound_sms = client.inbound_sms_messages.collection.first  # <TMS::InboundSmsMessage href=/inbound/sms/10041 attributes={...}>
+inbound_sms.to                                              # "+15559999999"
+inbound_sms.from                                            # "+15005550006"
+inbound_sms.attributes                                      # {:from=>"+15005550006", :to=>"+15559999999", :body=>"test", :command_status=>"success", :keyword_response=>"kwidjebo", :created_at=>"2014-11-05T17:15:01Z"}
+
+```
+
 ### Sending an Email Message
 
 ```ruby
@@ -221,6 +231,27 @@ commands.collection.each do |c|
 end
 ```
 
+### Viewing Command Actions
+Each time a given command is executed, a command action is created.
+
+**Note** The actions relationship does not exist on commands that have 0 command actions. Because of this, an attempt to access the command_actions attribute of a 
+command that has 0 command actions will result in a NoMethodError.
+
+```ruby
+# Using the command from above
+begin
+  command.get
+  command_actions = command.command_actions
+  command_actions.get
+  command_action = command_actions.collection.first
+  command_action.inbound_sms_message		# InboundSmsMessage object that initiated this command execution 
+  command_action.response_body			# String returned by the forwarded to URL
+  command_action.status				# HTTP Status returned by the forwarded to URL
+  command_action.content_type			# Content-Type header returned by the forwarded to URL
+rescue NoMethodError => e
+  # No command actions to view
+end
+```
 
 Logging
 -------

data/lib/tms_client/instance_resource.rb

@@ -111,6 +111,7 @@ module TMS::InstanceResource
       raise TMS::Errors::InvalidGet if self.new_record?
       process_response(client.get(self.href), :get) && self
     end
+    alias_method :get!, :get
 
     def post
       self.errors = nil
@@ -125,10 +126,18 @@ module TMS::InstanceResource
       process_response(client.put(self), :put)
     end
 
+    def put!
+      process_response(client.put(self), :put) or raise TMS::Errors::InvalidPut.new(self)
+    end
+
     def delete
       process_response(client.delete(self.href), :delete)
     end
 
+    def delete!
+      process_response(client.delete(self.href), :delete) or raise TMS::Errors::InvalidDelete.new(self)
+    end
+
     def to_s
       "<#{self.class.inspect}#{' href=' + self.href if self.href} attributes=#{@attributes.inspect}>"
     end
@@ -152,7 +161,7 @@ module TMS::InstanceResource
 
     def process_response(response, method)
       self.response = response
-      error_class = TMS::Errors.const_get("Invalid#{method.to_s.capitalize}")
+      error_class   = TMS::Errors.const_get("Invalid#{method.to_s.capitalize}")
       case response.status
         when 204
           return true
@@ -177,7 +186,7 @@ module TMS::InstanceResource
     def set_attributes_from_hash(hash)
       hash.reject { |k, _| k=~/^_/ }.each do |property, value|
         if self.class.collection_attributes.include?(property.to_sym)
-          klass = self.class.custom_class_names[property] || TMS.const_get(property.to_s.capitalize)
+          klass                        = self.class.custom_class_names[property] || TMS.const_get(property.to_s.capitalize)
           @attributes[property.to_sym] = klass.new(client, nil, value)
         else
           @attributes[property.to_sym] = value

data/lib/tms_client/version.rb

@@ -1,3 +1,3 @@
 module TMS #:nodoc:
-  VERSION = "0.5.3"
+  VERSION = "0.5.4"
 end

data/spec/instance_resource_spec.rb

@@ -43,6 +43,16 @@ describe TMS::InstanceResource do
       foo.get.should == foo
     end
 
+    %w{get post put delete}.each do |verb|
+      it "should blow up on invalid #{verb}!" do
+        client.should(receive(verb)).and_return(double('response', status: 404, body: "{}"))
+        foo = Foo.new(client, 'https://example.com/foos/1')
+        expect do
+          foo.send("#{verb}!")
+        end.to raise_error("TMS::Errors::Invalid#{verb.capitalize}".constantize)
+      end
+    end
+
     it 'it exposes its attributes hash' do
       @instance_resource.attributes.should == {}
     end

data/tms_client.gemspec

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
 require "tms_client/version"
-  
+
 Gem::Specification.new do |s|
   s.name        = "tms_client"
   s.version     = TMS::VERSION
@@ -10,12 +10,10 @@ Gem::Specification.new do |s|
   s.email       = ["support@govdelivery.com"]
   s.homepage    = "http://govdelivery.com"
   s.summary     = %q{A ruby client to interact with the GovDelivery TMS REST API.}
-  s.description = %q{A reference implementation, written in Ruby, 
-                     to interact with GovDelivery's TMS API. The client is 
+  s.description = %q{A reference implementation, written in Ruby,
+                     to interact with GovDelivery's TMS API. The client is
                      compatible with Ruby 1.9 and 2.0. }
 
-  # This will default active support to the latest stable version
-  # if the variable is nil. 
   s.add_runtime_dependency "activesupport"
   s.add_runtime_dependency "faraday"
   s.add_runtime_dependency "faraday_middleware"
@@ -28,6 +26,5 @@ Gem::Specification.new do |s|
   } + Dir["lib/**/*"]
 
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-end
+end

metadata

@@ -1,90 +1,70 @@
 --- !ruby/object:Gem::Specification
 name: tms_client
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.4
 platform: ruby
 authors:
 - GovDelivery
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-16 00:00:00.000000000 Z
+date: 2014-12-04 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
   prerelease: false
   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
   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'
-description: "A reference implementation, written in Ruby, \n                     to
-  interact with GovDelivery's TMS API. The client is \n                     compatible
+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:
-- autospec
-- htmldiff
-- ldiff
-- rake
-- redcarpet
-- rspec
-- tt
-- yard
-- yardoc
-- yri
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
 - README.md
 - Rakefile
-- bin/autospec
-- bin/htmldiff
-- bin/ldiff
-- bin/rake
-- bin/redcarpet
-- bin/rspec
-- bin/tt
-- bin/yard
-- bin/yardoc
-- bin/yri
-- lib/tms_client.rb
+- tms_client.gemspec
 - lib/tms_client/base.rb
 - lib/tms_client/client.rb
 - lib/tms_client/collection_resource.rb
@@ -121,6 +101,7 @@ files:
 - 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
@@ -142,7 +123,6 @@ files:
 - spec/tms_client_spec.rb
 - spec/voice_message_spec.rb
 - spec/voice_messages_spec.rb
-- tms_client.gemspec
 homepage: http://govdelivery.com
 licenses: []
 metadata: {}
@@ -152,17 +132,17 @@ 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.2.2
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: A ruby client to interact with the GovDelivery TMS REST API.

data/bin/autospec

@@ -1,16 +0,0 @@
-#!/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

@@ -1,16 +0,0 @@
-#!/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

@@ -1,16 +0,0 @@
-#!/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

@@ -1,16 +0,0 @@
-#!/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

@@ -1,16 +0,0 @@
-#!/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

@@ -1,16 +0,0 @@
-#!/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

@@ -1,16 +0,0 @@
-#!/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

@@ -1,16 +0,0 @@
-#!/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

@@ -1,16 +0,0 @@
-#!/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

@@ -1,16 +0,0 @@
-#!/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')