tms_client 0.2.0 → 0.2.1

data/README.md

@@ -55,7 +55,8 @@ message.get              # <TMS::SmsMessage href=/messages/sms/87 attributes={..
 
 ```ruby
 message = client.email_messages.build(:body=>'<p><a href="http://example.com">Visit here</a>', 
-                                      :subject => 'Hey')
+                                      :subject => 'Hey',
+                                      :from_email => 'foo@example.com')
 message.recipients.build(:email=>'example1@example.com')
 message.recipients.build(:email=>'')
 message.post             # true

data/lib/tms_client/client.rb

@@ -1,9 +1,10 @@
+require 'logger'
 # The client class to connect and talk to the TMS REST API.
 class TMS::Client
   include TMS::Util::HalLinkParser
   include TMS::CoreExt
 
-  attr_accessor :connection, :href
+  attr_accessor :connection, :href, :api_root, :logger
 
   DEFAULTS = {:api_root => 'http://localhost:3000', :logger => nil}.freeze
 
@@ -20,13 +21,14 @@ class TMS::Client
   #                               :logger => Logger.new(STDOUT)})
   #
   def initialize(auth_token, options = DEFAULTS)
-    @api_root = options[:api_root]
-    connect!(auth_token, options[:logger])
+    @api_root = options.delete(:api_root)
+    @logger = options.delete(:logger) || setup_logging(options.delete(:debug))
+    connect!(auth_token, options)
     discover!
   end
 
-  def connect!(auth_token, logger)
-    self.connection = TMS::Connection.new(:auth_token => auth_token, :api_root => @api_root, :logger => logger)
+  def connect!(auth_token, options={})
+    self.connection = TMS::Connection.new({:auth_token => auth_token, :api_root => api_root, :logger => logger}.merge!(options))
   end
 
   def discover!
@@ -37,12 +39,14 @@ class TMS::Client
   def get(href)
     response = raw_connection.get(href)
     case response.status
-    when 401..499
-      raise TMS::Request::Error.new(response.status)
-    when 202
-      raise TMS::Request::InProgress.new(response.body['message'])
-    else
-      return response
+      when 500..599
+        raise TMS::Request::Error.new(response.status)
+      when 401..499
+        raise TMS::Request::Error.new(response.status)
+      when 202
+        raise TMS::Request::InProgress.new(response.body['message'])
+      else
+        return response
     end
   end
 
@@ -65,10 +69,10 @@ class TMS::Client
   def delete(href)
     response = raw_connection.delete(href)
     case response.status
-    when 200
-      return response
-    else
-      raise TMS::Request::Error.new(response.status)
+      when 200
+        return response
+      else
+        raise TMS::Request::Error.new(response.status)
     end
   end
 
@@ -80,4 +84,12 @@ class TMS::Client
     self
   end
 
+  private
+
+  def setup_logging(debug)
+    logger = Logger.new(STDOUT)
+    logger.level = debug ? Logger::DEBUG : Logger::INFO
+    logger
+  end
+
 end

data/lib/tms_client/connection.rb

@@ -1,5 +1,5 @@
 class TMS::Connection
-  attr_accessor :auth_token, :api_root, :connection, :logger
+  attr_accessor :auth_token, :api_root, :connection, :logger, :debug
 
   def get(href)
     resp = connection.get("#{href}.json")
@@ -12,8 +12,9 @@ class TMS::Connection
 
   def initialize(opts={})
     self.auth_token = opts[:auth_token]
-    self.api_root   = opts[:api_root]
-    self.logger     = opts[:logger]
+    self.api_root = opts[:api_root]
+    self.logger = opts[:logger]
+    self.debug = opts[:debug]
     setup_connection
   end
 
@@ -21,10 +22,25 @@ class TMS::Connection
     self.connection = Faraday.new(:url => self.api_root) do |faraday|
       faraday.use TMS::Logger, self.logger if self.logger
       faraday.request :json
+      setup_logging(faraday)
       faraday.headers['X-AUTH-TOKEN'] = auth_token
       faraday.headers[:user_agent] = "GovDelivery Ruby TMS::Client #{TMS::VERSION}"
       faraday.response :json, :content_type => /\bjson$/
       faraday.adapter :net_http
     end
   end
+
+  def setup_logging(faraday)
+    faraday.use FaradayMiddleware::Instrumentation, {:name => 'tms_client'}
+    ActiveSupport::Notifications.subscribe('tms_client') do |name, starts, ends, _, env|
+      duration = ends - starts
+      logger.info "#{env[:method].to_s.upcase.ljust(7)}#{env[:status].to_s.ljust(4)}#{env[:url]} (#{duration} seconds)"
+      logger.debug('response headers') { JSON.pretty_generate env[:response_headers] }
+      logger.debug('response body') { env[:body] }
+    end
+  end
+
+  def dump_headers(headers)
+    headers.map { |k, v| "#{k}: #{v.inspect}" }.join("\n")
+  end
 end

data/lib/tms_client/errors.rb

@@ -1,6 +1,22 @@
 module TMS
+  module Request
+# The generic TMS error class
+    class Error < StandardError
+      attr_reader :code
+
+      def initialize(code)
+        super("HTTP Error: #{code}")
+        @code=code
+      end
+    end
+
+    # Raised when a recipient list is still being constructed and a request is made to view the
+    # recipient list for a message.
+    class InProgress < StandardError;end
+  end
+
   module Errors
-    class ServerError
+    class ServerError < StandardError
       def initialize(response)
         super("TMS client encountered a server error: #{response.status} \n#{response.body}")
       end

data/lib/tms_client/logger.rb

@@ -13,22 +13,10 @@ module TMS #:nodoc:
     def_delegators :@logger, :debug, :info, :warn, :error, :fatal
 
     def call(env)
-      puts env.inspect
-      info "#{env[:method]} #{env[:url].to_s}"
-      debug('request') { dump_headers env[:request_headers] }
+      debug "performing #{env[:method].to_s.upcase.ljust(7)} #{env[:url]}"
       super
     end
 
-    def on_complete(env)
-      info('Status') { env[:status].to_s }
-      debug('response headers') { dump_headers env[:response_headers] }
-      debug('response body') { env[:body].inspect }
-    end
-
-    private
 
-    def dump_headers(headers)
-      headers.map { |k, v| "#{k}: #{v.inspect}" }.join("\n")
-    end
   end
 end

data/lib/tms_client/resource/email_message.rb

@@ -4,6 +4,7 @@ module TMS #:nodoc:
   # 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]            The email adderess of the person or entity sending the email.  Must be configured in TMS beforehand.  Defaults to the account default from address. 
   # @attr subject   [String]             The subject of the email
   # @attr body      [String]             The body of the email
   # @attr open_tracking_enabled [Boolean] Whether to track opens on this message. Optional, defaults to true.
@@ -12,7 +13,9 @@ module TMS #:nodoc:
   #                              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!", :body => "You win! <a href='http://example.com/'>click here</a>.")
+  #    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")
   #    email_message.recipients.build(:email => "jeff@example.com")
   #    email_message.post
@@ -38,8 +41,8 @@ module TMS #:nodoc:
   class EmailMessage
     include InstanceResource
 
-    # @!parse attr_accessor :body, :from_name, :subject, :open_tracking_enabled, :click_tracking_enabled, :macros
-    writeable_attributes :body, :from_name, :subject, :open_tracking_enabled, :click_tracking_enabled, :macros
+    # @!parse attr_accessor :body, :from_name, :from_email, :subject, :open_tracking_enabled, :click_tracking_enabled, :macros
+    writeable_attributes :body, :from_name, :from_email, :subject, :open_tracking_enabled, :click_tracking_enabled, :macros
 
     # @!parse attr_reader :created_at, :status
     readonly_attributes :created_at, :status

data/lib/tms_client/version.rb

@@ -1,3 +1,3 @@
 module TMS #:nodoc:
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/lib/tms_client.rb

@@ -15,7 +15,6 @@ require 'tms_client/logger'
 require 'tms_client/base'
 require 'tms_client/instance_resource'
 require 'tms_client/collection_resource'
-require 'tms_client/request'
 require 'tms_client/errors'
 
 require 'tms_client/resource/collections'

data/spec/client_spec.rb

@@ -2,11 +2,15 @@ require 'spec_helper'
 describe TMS::Client do
   context "creating a new client" do
     before do
-      response = double('response', :status=>200, :body => {"_links" => [{"self" => "/"}, {"horse" => "/horses/new"}, {"rabbits" => "/rabbits"}]})
+      response = double('response', :status => 200, :body => {"_links" => [{"self" => "/"}, {"horse" => "/horses/new"}, {"rabbits" => "/rabbits"}]})
       @raw_connection = double('raw_connection', :get => response)
       @connection = TMS::Connection.stub(:new).and_return(double('connection', :connection => @raw_connection))
       @client = TMS::Client.new('auth_token', :api_root => 'null_url')
     end
+    it 'should set up logging' do
+      @client.logger.should_not be_nil
+      @client.logger.level.should eq(Logger::INFO)
+    end
     it 'should discover endpoints for known services' do
       @client.horse.should be_kind_of(TMS::Horse)
       @client.rabbits.should be_kind_of(TMS::Rabbits)
@@ -15,6 +19,10 @@ describe TMS::Client do
       @raw_connection.stub(:get).and_return(double('response', :status => 404, :body => {'message' => 'hi'}))
       expect { @client.get('/blargh') }.to raise_error(TMS::Request::Error)
     end
+    it 'should handle 5xx responses' do
+      @raw_connection.stub(:get).and_return(double('response', :status => 503, :body => {'message' => 'oops'}))
+      expect { @client.get('/blargh') }.to raise_error(TMS::Request::Error)
+    end
     it 'should handle 202 responses' do
       @raw_connection.stub(:get).and_return(double('response', :status => 202, :body => {'message' => 'hi'}))
       expect { @client.get('/blargh') }.to raise_error(TMS::Request::InProgress)

data/spec/email_message_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe TMS::EmailMessage do
+  context "creating a new message" do
+    let(:client) do
+      double('client')
+    end
+    before do
+      @message = TMS::EmailMessage.new(client, nil, {:body => '12345678', 
+                                                     :subject => 'blah', 
+                                                     :created_at => 'BAAAAAD',
+                                                     :from_email => 'eric@evotest.govdelivery.com'})
+    end
+    it 'should not render readonly attrs in json hash' do
+      @message.to_json[:body].should == '12345678'
+      @message.to_json[:created_at].should == nil
+    end
+    it 'should initialize with attrs and collections' do
+      @message.body.should == '12345678'
+      @message.subject.should == 'blah'
+      @message.from_email.should == 'eric@evotest.govdelivery.com'
+      @message.recipients.class.should == TMS::EmailRecipients
+    end
+    it 'should post successfully' do
+      response = {:body => 'processed', :subject => 'blah', :from_email => 'eric@evotest.govdelivery.com', 
+                  :recipients => [{:email => 'billy@evotest.govdelivery.com'}], :created_at => 'time'}
+      @message.client.should_receive('post').with(@message).and_return(double('response', :status => 201, :body => response))
+      @message.post
+      @message.body.should == 'processed'
+      @message.created_at.should == 'time'
+      @message.recipients.class.should == TMS::EmailRecipients
+      @message.recipients.collection.first.class.should == TMS::EmailRecipient
+    end
+    it 'should handle errors' do
+      response = {'errors' => {:body => "can't be nil"}}
+      @message.client.should_receive('post').with(@message).and_return(double('response', :status => 422, :body => response))
+      @message.post
+      @message.body.should == '12345678'
+      @message.errors.should == {:body => "can't be nil"}
+    end
+  end
+
+  context 'an existing message' do
+    let(:client) do
+      double('client')
+    end
+    before do
+      # blank hash prevents the client from doing a GET in the initialize method
+      @message = TMS::EmailMessage.new(client, '/messages/99', {})
+    end
+    it 'should GET cleanly' do
+      response = {:body => 'processed', 
+                  :subject => 'hey',
+                  :from_email => 'eric@evotest.govdelivery.com',
+                  :recipients => [{:email => 'billy@evotest.govdelivery.com'}], :created_at => 'time'}
+      @message.client.should_receive('get').with(@message.href).and_return(double('response', :status => 200, :body => response))
+      @message.get
+      @message.body.should == 'processed'
+      @message.subject.should == 'hey'
+      @message.from_email.should == 'eric@evotest.govdelivery.com'
+      @message.created_at.should == 'time'
+    end
+  end
+
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tms_client
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-14 00:00:00.000000000 Z
+date: 2013-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -80,7 +80,6 @@ files:
 - lib/tms_client/link_header.rb
 - lib/tms_client/logger.rb
 - lib/tms_client/mail/delivery_method.rb
-- lib/tms_client/request.rb
 - lib/tms_client/resource/collections.rb
 - lib/tms_client/resource/command.rb
 - lib/tms_client/resource/command_action.rb
@@ -100,13 +99,14 @@ files:
 - lib/tms_client.rb
 - spec/client_spec.rb
 - spec/command_types_spec.rb
+- spec/email_message_spec.rb
 - spec/inbound_sms_messages_spec.rb
 - spec/instance_resource_spec.rb
 - spec/keyword_spec.rb
 - spec/keywords_spec.rb
 - spec/mail/delivery_method_spec.rb
-- spec/message_spec.rb
-- spec/messages_spec.rb
+- spec/sms_message_spec.rb
+- spec/sms_messages_spec.rb
 - spec/spec_helper.rb
 - spec/tms_client_spec.rb
 homepage: http://govdelivery.com
@@ -123,7 +123,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2902560472954263906
+      hash: 2675598689048053801
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -132,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2902560472954263906
+      hash: 2675598689048053801
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -142,12 +142,13 @@ summary: A ruby client to interact with the GovDelivery TMS REST API.
 test_files:
 - spec/client_spec.rb
 - spec/command_types_spec.rb
+- spec/email_message_spec.rb
 - spec/inbound_sms_messages_spec.rb
 - spec/instance_resource_spec.rb
 - spec/keyword_spec.rb
 - spec/keywords_spec.rb
 - spec/mail/delivery_method_spec.rb
-- spec/message_spec.rb
-- spec/messages_spec.rb
+- spec/sms_message_spec.rb
+- spec/sms_messages_spec.rb
 - spec/spec_helper.rb
 - spec/tms_client_spec.rb

data/lib/tms_client/request.rb

@@ -1,17 +0,0 @@
-module TMS #:nodoc:
-  module Request
-    # The generic TMS error class
-    class Error < StandardError
-      attr_reader :code
-
-      def initialize(code)
-        super("HTTP Error: #{code}")
-        @code=code
-      end
-    end
-
-    # Raised when a recipient list is still being constructed and a request is made to view the 
-    # recipient list for a message.
-    class InProgress < StandardError; end
-  end
-end