tms_client 0.1.1 → 0.2.0

data/README.md

@@ -22,7 +22,7 @@ Connecting
 Loading an instance of `TMS::Client` will automatically connect to the API to query the available resources for your account.
 
 ```ruby
-client = TMS::Client.new('username', 'password', :api_root => 'https://stage-tms.govdelivery.com')
+client = TMS::Client.new('auth_token', :api_root => 'https://stage-tms.govdelivery.com')
 ```
 
 Messages
@@ -173,7 +173,7 @@ The example below configures `TMS::Client` to log to `STDOUT`:
 
 ```ruby
 logger = Logger.new(STDOUT)
-client = TMS::Client.new('username', 'password', :logger => logger)
+client = TMS::Client.new('auth_token', :logger => logger)
 ```
 
 ActionMailer integration
@@ -190,8 +190,7 @@ config/environment.rb
 ```ruby
 config.action_mailer.delivery_method = :govdelivery_tms
 config.action_mailer.govdelivery_tms_settings = {
-    :username=>'email@foo.com',
-    :password=>'pass',
+    :auth_token=>'auth_token',
     :api_root=>'https://stage-tms.govdelivery.com'
     }
 ```

data/lib/tms_client/client.rb

@@ -9,25 +9,24 @@ class TMS::Client
 
   # Create a new client and issue a request for the available resources for a given account.
   #
-  # @param [String] username The username of your account
-  # @param [String] password The password of your account
+  # @param [String] auth_token The auth_token of your account
   # @param [Hash] options
   # @option options [String] :api_root The root URL of the TMS api. Defaults to localhost:3000
   # @option options [Logger] :logger An instance of a Logger class (http transport information will be logged here) - defaults to nil
   #
   # @example
-  #   client = TMS::Client.new("foo@example.com", "onetwothree", {
+  #   client = TMS::Client.new("auth_token", {
   #                               :api_root => "https://tms.govdelivery.com",
   #                               :logger => Logger.new(STDOUT)})
   #
-  def initialize(username, password, options = DEFAULTS)
+  def initialize(auth_token, options = DEFAULTS)
     @api_root = options[:api_root]
-    connect!(username, password, options[:logger])
+    connect!(auth_token, options[:logger])
     discover!
   end
 
-  def connect!(username, password, logger)
-    self.connection = TMS::Connection.new(:username => username, :password => password, :api_root => @api_root, :logger => logger)
+  def connect!(auth_token, logger)
+    self.connection = TMS::Connection.new(:auth_token => auth_token, :api_root => @api_root, :logger => logger)
   end
 
   def discover!

data/lib/tms_client/connection.rb

@@ -1,5 +1,5 @@
 class TMS::Connection
-  attr_accessor :username, :password, :api_root, :connection, :logger
+  attr_accessor :auth_token, :api_root, :connection, :logger
 
   def get(href)
     resp = connection.get("#{href}.json")
@@ -11,10 +11,9 @@ class TMS::Connection
   end
 
   def initialize(opts={})
-    self.username = opts[:username]
-    self.password = opts[:password]
-    self.api_root = opts[:api_root]
-    self.logger   = opts[:logger]
+    self.auth_token = opts[:auth_token]
+    self.api_root   = opts[:api_root]
+    self.logger     = opts[:logger]
     setup_connection
   end
 
@@ -22,7 +21,8 @@ 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
-      faraday.basic_auth(self.username, self.password)
+      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

data/lib/tms_client/mail/delivery_method.rb

@@ -11,8 +11,7 @@ module TMS
     #   # config/environment.rb
     #   config.action_mailer.delivery_method = :govdelivery_tms
     #   config.action_mailer.govdelivery_tms_settings = {
-    #     :username=>'email@foo.com',
-    #     :password=>'pass',
+    #     :auth_token=>'auth_token',
     #     :api_root=>'https://stage-tms.govdelivery.com'
     #     }
     class DeliveryMethod
@@ -42,7 +41,7 @@ module TMS
       end
 
       def client
-        @client ||= TMS::Client.new(settings[:username], settings[:password], settings)
+        @client ||= TMS::Client.new(settings[:auth_token], settings)
       end
     end
   end
@@ -50,8 +49,7 @@ end
 
 if defined?(ActionMailer)
   ActionMailer::Base.add_delivery_method :govdelivery_tms, TMS::Mail::DeliveryMethod, {
-    :username => nil,
-    :password => nil,
+    :auth_token => nil,
     :logger => ActionMailer::Base.logger,
     :api_root => TMS::Client::DEFAULTS[:api_root]}
 end

data/lib/tms_client/version.rb

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

data/spec/client_spec.rb

@@ -5,7 +5,7 @@ describe TMS::Client do
       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('username', 'password', :api_root => 'null_url')
+      @client = TMS::Client.new('auth_token', :api_root => 'null_url')
     end
     it 'should discover endpoints for known services' do
       @client.horse.should be_kind_of(TMS::Horse)

metadata

@@ -1,58 +1,65 @@
 --- !ruby/object:Gem::Specification
 name: tms_client
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
+  prerelease: 
 platform: ruby
 authors:
 - GovDelivery
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-01 00:00:00.000000000 Z
+date: 2013-06-14 00:00:00.000000000 Z
 dependencies:
 - !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'
 - !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'
-description: 'A reference implementation, written in Ruby, to interact with GovDelivery''s
+description: ! 'A reference implementation, written in Ruby, to interact with GovDelivery''s
   TMS API. The client is compatible with Ruby versions 1.8.7 and 1.9.3. '
 email:
 - support@govdelivery.com
@@ -104,26 +111,33 @@ files:
 - spec/tms_client_spec.rb
 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: -2902560472954263906
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -2902560472954263906
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 1.8.25
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: A ruby client to interact with the GovDelivery TMS REST API.
 test_files:
 - spec/client_spec.rb

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: b7a0be5e64161ecf0605c965d2bb949ec4b157db
-  data.tar.gz: 6f725c6cb7c2f771dd7cbc07d67f00ad113af1fb
-SHA512:
-  metadata.gz: 8ede49f2709329392caa5e954071b769f136abe14f6ad32f7f1f8ca617314fe0f07a4025c6e1dc2d6cd7bd4298bc0d8d961381d366e46671d38da898a2b16197
-  data.tar.gz: 4bc8ad9a68092470eea57fd069d6cc6fba3c1b0491f0c28489be27141a3ec25f8f760078e2e53ec76ced4edb35cf4062d72cd03068a323ade5f46b50f9303abb