autodiscover 0.1.0 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 67ca31043ee9ef53aebe329e4a07d65b0d0fb36a
+  data.tar.gz: 1bc1b1a2063a628051f8cb218b983db4088fc41e
+SHA512:
+  metadata.gz: c643328d246d2d51e3882af159b2c3fabd27854441deb673b5bde042542faf352901b17a96a7c266becf63cb4748730393d16e859772dbce0db038dab59f50bc
+  data.tar.gz: 22413ce0ba0e22beefccec5409ac183ac8244d70567a601128bdab8831bd652e2eb2f98cc9900f967de6b8e6a211c309349ea7ed9d33eb2a5e6caeb2a2ab91db

data/.gitignore

@@ -0,0 +1,19 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.ruby-version
+/.ruby-gemset
+/.rvm
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+scratch.rb
+*.sw[op]

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - rbx-2
+  - ruby-head
+  - jruby-head

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in autodiscover.gemspec
+gemspec

data/README.md

@@ -1,9 +1,11 @@
+[![Build Status](https://travis-ci.org/WinRb/autodiscover.svg?branch=master)](https://travis-ci.org/WinRb/autodiscover)
+
 Autodiscover
 ============
 
 Ruby client for Microsoft's Autodiscover Service.
 
-The Autodiscover Service is a component of the Exchange 2007 and Exchange 2010 architecture. Autoservice clients can access the URLs and settings needed to communicate with Exchange servers, such as the URL of the endpoint to use with the Exchange Web Services (EWS) API.
+The Autodiscover Service is a component of the Microsoft Exchange architecture. Autoservice clients can access the URLs and settings needed to communicate with Exchange servers, such as the URL of the endpoint to use with the Exchange Web Services (EWS) API.
 
 This library implements Microsoft's "Autodiscover HTTP Service Protocol Specification" to discover the endpoint for an Autodiscover server that supports a specified e-mail address and Microsoft's "Autodiscover Publishing and Lookup Protocol Specification" to get URLs and settings that are required to access Web services available from Exchange servers.
 
@@ -14,53 +16,58 @@ This library requires the following Gems:
 
 * HTTPClient
 * Nokogiri
+* Nori
 
 The HTTPClient Gem in turn requires the rubyntlm Gem for Negotiate/NTLM authentication.
 
-For unit testing the webmock Gem is also used.
-
 How to Use
 ----------
 
-    require 'autodiscover'
-    
-    credentials = Autodiscover::Credentials.new('<e-mail address>', '<password>')
-    client = Autodiscover::Client.new
-    services = client.get_services(credentials)
-    ews_url = services.ews_url
-    ttl = services.ttl
+```ruby
+require 'autodiscover'
+
+client = Autodiscover::Client.new(email: "blumbergh@initech.local", password: "tps_eq_awesome")
+data = client.autodiscover
+
+# Get the EWS endpoint
+data.ews_url
+
+# Get an Exchange Version ingestible by EWS
+data.exchange_version
+
+# Access the raw Autodiscover data in its entirety
+data.response
+```
 
 Options
 -------
 
-### Debugging
-
-For debugging, we extend the use of the debug_dev option in the HTTPClient library.
+Besides `:email` and `:password`, `Autodiscover::Client` can take a few other options as can the #autodiscover method.
 
-    debug_file = File.open('<filename path>', 'w')
-    credentials = Autodiscover::Credentials.new('<e-mail address>', '<password>')
-    client = Autodiscover::Client.new(:debug_dev => debug_file)
-    services = client.get_services(credentials)
-    debug_file.close
+Examples:
 
-### Connection Timeouts
+```ruby
+# Use a different username than your e-mail.
+client = Autodiscover::Client.new(email: "blumbergh@initech.local", password: "tps_eq_awesome", username: 'INITECH\blumbergh')
 
-To adjust the connection timeout values used when searching for Autodiscover server endpoints:
+# Override the domain
+client = Autodiscover::Client.new(email: "blumbergh@initech.local", password: "tps_eq_awesome", domain: "tpsreports.local")
 
-    client = Autodiscover::Client.new(:connect_timeout => 5)
+# Ignore SSL Errors
+client.autodiscover(ignore_ssl_errors: true)
+```
 
-The units are seconds.
 
 Installation
 ------------
 
 ### Configuring a Rails App to use the latest GitHub master version
 
-	  gem 'autodiscover', :git => 'git://github.com/wimm/autodiscover.git'
+	  gem 'autodiscover', :git => 'git://github.com/WinRb/autodiscover.git'
 
 ### To install the latest development version from the GitHub master
 
-	  git clone http://github.com/wimm/autodiscover.git
+	  git clone http://github.com/WinRb/autodiscover.git
 	  cd autodiscover
 	  gem build autodiscover.gemspec
 	  sudo gem install autodiscover-<version>.gem
@@ -71,11 +78,5 @@ Bugs and Issues
 Limitations:
 
 * Doesn't support querying the DNS for SRV Records
-* Only returns the TTL and EWS_Url values from the EXPR Protocol response
-
-Please submit additional bugs and issues here [http://github.com/wimm/autodiscover/issues](http://github.com/wimm/autodiscover/issues)
-
-Copyright
----------
 
-Copyright (c) 2010-2011 WIMM Labs, Inc. See MIT-LICENSE for details.
+Please submit additional bugs and issues here [http://github.com/WinRb/autodiscover/issues](http://github.com/WinRb/autodiscover/issues)

data/Rakefile

@@ -0,0 +1,19 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task :default => :test
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+desc "Open a Pry console for this library"
+task :console do
+  require "pry"
+  require "autodiscover"
+  ARGV.clear
+  Pry.start
+end

data/autodiscover.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'autodiscover/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'autodiscover'
+  s.version       = Autodiscover::VERSION
+  s.summary       = "Ruby client for Microsoft's Autodiscover Service"
+  s.description   = "The Autodiscover Service provides information about a Microsoft Exchange environment such as service URLs, versions and many other attributes."
+  s.required_ruby_version = '>= 2.1.0'
+
+  s.authors       = ["David King", "Dan Wanek"]
+  s.email         = ["dking@bestinclass.com", "dan.wanek@gmail.com"]
+  s.homepage      = 'http://github.com/WinRb/autodiscover'
+
+  s.files         = `git ls-files -z`.split("\x0")
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency  "nokogiri"
+  s.add_runtime_dependency  "nori"
+  s.add_runtime_dependency  "httpclient"
+
+  s.add_development_dependency "minitest", "~> 5.6.0"
+  s.add_development_dependency "mocha", "~> 1.1.0"
+  s.add_development_dependency "bundler"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "pry"
+end

data/lib/autodiscover.rb

@@ -1,26 +1,13 @@
-#--
-# Copyright (c) 2010-2011 WIMM Labs, Inc.
-#
-# Permission is hereby granted, free of charge, to any person obtaining
-# a copy of this software and associated documentation files (the
-# "Software"), to deal in the Software without restriction, including
-# without limitation the rights to use, copy, modify, merge, publish,
-# distribute, sublicense, and/or sell copies of the Software, and to
-# permit persons to whom the Software is furnished to do so, subject to
-# the following conditions:
-#
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-#++
+require "autodiscover/version"
+require "nokogiri"
+require "nori"
+require "httpclient"
 
-require 'autodiscover/client'
-require 'autodiscover/credentials'
-require 'autodiscover/services'
+module Autodiscover
+end
+
+require "autodiscover/errors"
+require "autodiscover/client"
+require "autodiscover/pox_request"
+require "autodiscover/pox_response"
+require "autodiscover/server_version_parser"

data/lib/autodiscover/client.rb

@@ -1,226 +1,33 @@
-#--
-# Copyright (c) 2010-2011 WIMM Labs, Inc.
-#
-# Permission is hereby granted, free of charge, to any person obtaining
-# a copy of this software and associated documentation files (the
-# "Software"), to deal in the Software without restriction, including
-# without limitation the rights to use, copy, modify, merge, publish,
-# distribute, sublicense, and/or sell copies of the Software, and to
-# permit persons to whom the Software is furnished to do so, subject to
-# the following conditions:
-#
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-#++
-
-require 'httpclient'
-require 'nokogiri'
-
 module Autodiscover
-  REDIRECT_LIMIT = 10  # attempts
-  CONNECT_TIMEOUT_DEFAULT = 10  # seconds
-
-  # Client objects are used to make queries to the autodiscover server, to
-  # specify configuration values, and to maintain state between requests.
   class Client
-    # Creates a Client object.
-    #
-    # The following options can be specified:
-    #
-    # <tt>:connect_timeout</tt>::  Number of seconds to wait when trying to establish
-    #                              a connection. The default value is 10 seconds.
-    # <tt>:debug_dev</tt>::        Device that debug messages and all HTTP
-    #                              requests and responses are dumped to. The debug
-    #                              device must respond to <tt><<</tt> for dump. 
-    def initialize(options={})
-      @debug_dev = options[:debug_dev]
 
+    attr_reader :domain, :email, :http
+
+    # @param email [String] An e-mail to use for autodiscovery. It will be
+    #   used as the default username.
+    # @param password [String]
+    # @param username [String] An optional username if you want to authenticate
+    #   with something other than the e-mail. For instance DOMAIN\user
+    # @param domain [String] An optional domain to provide as an override for
+    #   the one parsed from the e-mail.
+    def initialize(email:, password:, username: nil, domain: nil)
+      @email = email
+      @domain = domain || @email.split("@").last
       @http = HTTPClient.new
-      @http.connect_timeout = options[:connect_timeout] || CONNECT_TIMEOUT_DEFAULT
-      @http.debug_dev = @debug_dev if @debug_dev
-
-      @redirect_count = 0
-    end
-
-    # Get a Services object from an \Autodiscover server that is
-    # available on an authenticated endpoint determined by the
-    # specified Credentials object.
-    def get_services(credentials, reset_redirect_count=true)
-      @redirect_count = 0 if reset_redirect_count
-
-      req_body = build_request_body credentials.email
-
-      try_standard_secure_urls(credentials, req_body) ||
-      try_standard_redirection_url(credentials, req_body) ||
-      try_dns_serv_record
-    end
-
-    private
-
-    def try_standard_secure_urls(credentials, req_body)
-      response = nil
-      [ "https://#{credentials.smtp_domain}/autodiscover/autodiscover.xml",
-        "https://autodiscover.#{credentials.smtp_domain}/autodiscover/autodiscover.xml"
-      ].each do |url|
-        @debug_dev << "AUTODISCOVER: trying #{url}\n" if @debug_dev
-        response = try_secure_url(url, credentials, req_body)
-        break if response
-      end
-      response
+      @username = username || email
+      @http.set_auth(nil, @username, password)
     end
 
-    def try_standard_redirection_url(credentials, req_body)
-      url = "http://autodiscover.#{credentials.smtp_domain}/autodiscover/autodiscover.xml"
-      @debug_dev << "AUTODISCOVER: looking for redirect from #{url}\n" if @debug_dev
-      response = @http.get(url) rescue nil
-      return nil unless response
-
-      if response.status_code == 302
-        try_redirect_url(response.header['Location'].first, credentials, req_body)
+    # @param type [Symbol] The type of response. Right now this is just :pox
+    # @param [Hash] **options
+    def autodiscover(type: :pox, **options)
+      case type
+      when :pox
+        PoxRequest.new(self, **options).autodiscover
       else
-        nil
+        raise Autodiscover::ArgumentError, "Not a valid autodiscover type (#{type})."
       end
     end
 
-    def try_secure_url(url, credentials, req_body)
-      @http.set_auth(url, credentials.email, credentials.password)
-
-      response = @http.post(url, req_body, {'Content-Type' => 'text/xml; charset=utf-8'}) rescue nil
-      return nil unless response
-
-      if response.status_code == 302
-        try_redirect_url(response.header['Location'].first, credentials, req_body)
-      elsif HTTP::Status.successful?(response.status_code)
-        result = parse_response(response.content)
-        case result
-          when Autodiscover::Services
-            return result
-          when Autodiscover::RedirectUrl
-            try_redirect_url(result.url, credentials, req_body)
-          when Autodiscover::RedirectAddress
-            begin
-              credentials.email = result.address
-            rescue ArgumentError
-              # An invalid email address was returned
-              return nil
-            end
-            
-            try_redirect_addr(credentials)
-        end
-      else
-        nil
-      end
-    end
-
-    def try_redirect_url(url, credentials, req_body)
-      @redirect_count += 1
-      return nil if @redirect_count > REDIRECT_LIMIT
-
-      # Only permit redirects to secure addresses
-      return nil unless url =~ /^https:/i
-      try_secure_url(url, credentials, req_body)
-    end
-
-    def try_redirect_addr(credentials)
-      @redirect_count += 1
-      return nil if @redirect_count > REDIRECT_LIMIT
-
-      get_services(credentials, false)
-    end
-
-    def try_dns_serv_record
-      nil
-    end
-
-    def build_request_body(email)
-      Nokogiri::XML::Builder.new do |xml| 
-        xml.Autodiscover('xmlns' => 'http://schemas.microsoft.com/exchange/autodiscover/outlook/requestschema/2006') {
-          xml.Request {
-            xml.EMailAddress email
-            xml.AcceptableResponseSchema 'http://schemas.microsoft.com/exchange/autodiscover/outlook/responseschema/2006a'
-          }
-        }
-      end.to_xml
-    end
-
-    NAMESPACES = {
-      'a' => 'http://schemas.microsoft.com/exchange/autodiscover/responseschema/2006',
-      'o' => 'http://schemas.microsoft.com/exchange/autodiscover/outlook/responseschema/2006a'        
-    }  #:nodoc:
-
-    def parse_response(body)
-      doc = parse_xml body
-      return nil unless doc
-
-      # The response must include an Account element. Return an error if not found.
-      account_e = doc.at_xpath('a:Autodiscover/o:Response/o:Account', NAMESPACES)
-      return nil unless account_e
-
-      # The response must include an Action element. Return an error if not found.
-      action_e = account_e.at_xpath('o:Action', NAMESPACES)
-      return nil unless action_e
-
-      case action_e.content
-        when /^settings$/i
-          # Response contains configuration settings in <Protocol> elements
-          # Only care about about "EXPR" type protocol configuration values
-          # for accessing Exchange services outside of the firewall
-          settings = {}
-          if protocol_e = account_e.at_xpath('o:Protocol[o:Type="EXPR"]', NAMESPACES)
-            # URL for the Web services virtual directory.
-            ews_url_e = protocol_e.at_xpath('o:EwsUrl', NAMESPACES)
-            settings['ews_url'] = ews_url_e.content if ews_url_e
-            # Time to Live (TTL) in hours. Default is 1 hour if no element is
-            # returned.
-            ttl_e = protocol_e.at_xpath('o:TTL', NAMESPACES)
-            settings['ttl'] = ttl_e ? ttl_e.content : 1
-          end
-          Autodiscover::Services.new(settings)
-        when /^redirectAddr$/i
-          # Response contains a new address that must be used to re-­Autodiscover
-          redirect_addr_e = account_e.at_xpath('o:RedirectAddr', NAMESPACES)
-          address = redirect_addr_e ? redirect_addr_e.content : nil
-          return nil unless address
-          Autodiscover::RedirectAddress.new(address)
-        when /^redirectUrl$/i
-          # Response contains a new URL that must be used to re-Autodiscover
-          redirect_url_e = account_e.at_xpath('o:RedirectUrl', NAMESPACES)
-          url = redirect_url_e ? redirect_url_e.content : nil
-          return nil unless url
-          Autodiscover::RedirectUrl.new(url)          
-        else
-          nil
-      end
-    end
-
-    def parse_xml(doc)
-      Nokogiri::XML(doc) { |c| c.options = Nokogiri::XML::ParseOptions::STRICT }
-    rescue Nokogiri::XML::SyntaxError
-      nil
-    end
-  end
-
-  class RedirectUrl  #:nodoc: all
-    attr_reader :url
-
-    def initialize(url)
-      @url = url
-    end
-  end
-
-  class RedirectAddress  #:nodoc: all
-    attr_reader :address
-
-    def initialize(address)
-      @address = address
-    end
   end
-end
+end