windows_live_admin 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8c76b690e75a556cdf481186e0eee996e8037a1e
+  data.tar.gz: 5e856aac4731760b40e8a63df879cc7e1562e982
+SHA512:
+  metadata.gz: 9164b0dc45a5e76108a312a70d66aa26810723b3c7ed6200e8228886d015e1ee7a6e5ea247a963b118712998c6908f019e7cac5d5c8b1d6b7e813851e9a5290c
+  data.tar.gz: 0d3e2a82f531f6c2a3fbdd3033834adfec2648f132584a3c8e7b6728e6108265d145c9ecad99a5d9db24628b69f4bb0a5e8546d6bb863cc27e236adc3384596f

data/lib/windows_live_admin/templates.rb

@@ -0,0 +1,107 @@
+# This module contains various template methods which return the XML request
+# that needs to be sent to the server to perform corresponding tasks. 
+# This module is mixed into the WindowsLiveAdmin class. Hence all the methods
+# defined here can be invoked directly on the objects of WindowsLiveAdmin class
+#
+module Templates
+  # Generates the XML required by the get_login_url method.
+  # @return [String] Complete XML with username filled in
+  def get_login_url_xml
+    str = <<-eos
+<?xml version="1.0" encoding="utf-8"?>
+<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+  <soap:Body>
+    <GetLoginUrl xmlns="http://domains.live.com/Service/ManageDomain/V1.0">
+      <memberNameIn>#{@username}</memberNameIn>
+    </GetLoginUrl>
+  </soap:Body>
+</soap:Envelope>
+    eos
+  end
+
+  # Generates the XML required by the get_login_data_template method.
+  # @return [String] XML required to be sent to the server
+  def get_login_data_template_xml
+    str = <<-eos
+<?xml version="1.0" encoding="utf-8"?>
+  <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+    <soap:Body>
+      <GetLoginDataTemplate xmlns="http://domains.live.com/Service/ManageDomain/V1.0" />
+    </soap:Body>
+</soap:Envelope>
+    eos
+  end
+
+  # Generates the XML required by the verify_auth_data method.
+  # @return [String] Complete XML with auth_data filled in
+  def verify_auth_data_xml
+    str = <<-eos
+<?xml version="1.0" encoding="utf-8"?>
+  <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+    <soap:Body>
+      <VerifyAuthData xmlns="http://domains.live.com/Service/ManageDomain/V1.0">
+        <authData>#{@auth_data}</authData>
+      </VerifyAuthData>
+    </soap:Body>
+</soap:Envelope>
+    eos
+  end
+
+  # Generates the XML required by the create_member method.
+  # This is a helper function.
+  # @param member_name [String] member's complete email id
+  # @param password [String] member's desired password
+  # @param reset_password [Boolean] a true/false value whether we want member to be forced to change her
+  #  password on first login.
+  # @param first_name [String] first name of member
+  # @param last_name [String] last name of member
+  # @param lcid [Sting] member's locale ID. Can be blank or nil 
+  # @return [String] Complete XML with member details filled in
+  def create_member_xml(member_name, password, reset_password, first_name, last_name, lcid)
+    str = <<-eos
+<?xml version="1.0" encoding="utf-8"?>
+  <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+    <soap:Header>
+      <ManageDomain2Authorization xmlns="http://domains.live.com/Service/ManageDomain/V1.0">
+        <authorizationType>PassportTicket</authorizationType>
+        <authorizationData>#{@auth_data}</authorizationData>
+      </ManageDomain2Authorization>
+    </soap:Header>
+    <soap:Body>
+      <CreateMember xmlns="http://domains.live.com/Service/ManageDomain/V1.0">
+        <memberNameIn>#{member_name}</memberNameIn>
+        <password>#{password}</password>
+        <resetPassword>#{reset_password}</resetPassword>
+        <firstName>#{first_name}</firstName>
+        <lastName>#{last_name}</lastName>
+        <lcid>#{lcid}</lcid>
+      </CreateMember>
+    </soap:Body>
+</soap:Envelope>
+    eos
+  end
+
+  # Generates the XML required by the delete_member method.
+  # This is a helper function.
+  # @param member_name [String] email id of the member who is to be deleted
+  # @return [String] Complete XML with auth_data and member details filled in
+  def delete_member_xml(member_name)
+    str = <<-eos
+<?xml version="1.0" encoding="utf-8"?>
+<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+  <soap:Header>
+    <ManageDomain2Authorization xmlns="http://domains.live.com/Service/ManageDomain/V1.0">
+      <authorizationType>PassportTicket</authorizationType>
+      <authorizationData>#{@auth_data}</authorizationData>
+    </ManageDomain2Authorization>
+  </soap:Header>
+  <soap:Body>
+    <DeleteMember xmlns="http://domains.live.com/Service/ManageDomain/V1.0">
+      <memberNameIn>#{member_name}</memberNameIn>
+    </DeleteMember>
+  </soap:Body>
+</soap:Envelope>
+    eos
+  end
+
+end # end of module Templates

data/lib/windows_live_admin.rb

@@ -0,0 +1,176 @@
+require 'net/http'
+require 'rexml/document'
+require File.dirname(__FILE__) +'/windows_live_admin/templates.rb'
+
+# This creates an windows admin live account instance.
+# The object instantiated will have various member/user/email manipulation methods.
+#
+# @author Shivam Patel 
+class WindowsLiveAdmin
+  include Templates # include the XML templates that various calls require
+  
+  # Constructor of the WindowsLiveAdmin class.	
+  # Inits class variables @username and @password and makes HTTP calls 
+  # to get login url and login template. Thereafter obtains auth_data by get_auth_data call
+  def initialize(username, password)
+    @username = username
+    @password = password
+
+    begin
+    login_url = get_login_url
+    login_template = get_login_data_template
+    @auth_data = get_auth_data(login_url, login_template)
+    rescue
+      @auth_data = nil   # nil auth_data signifies there was an error in the login process
+    end
+  end
+
+  # Fetches the login URl where the template needs to be posted to obtain the auth_data (token)
+  # @return [String] the login url obtained from the server
+  def get_login_url
+    http, request = get_request_headers('http://domains.live.com/Service/ManageDomain/V1.0/GetLoginUrl')
+    request.body = get_login_url_xml
+    #puts @request.body
+    response = http.request(request)
+    login_url =  REXML::XPath.first(REXML::Document.new(response.body), "//GetLoginUrlResult").text
+
+  end
+
+  # Fetches the login template from the server and replaces it with admin's username and password
+  # @return [String] login template with admin username and password filled in.
+  def get_login_data_template
+    http, request = get_request_headers("http://domains.live.com/Service/ManageDomain/V1.0/GetLoginDataTemplate")
+    request.body = get_login_data_template_xml
+     #puts @request.inspect
+    response = http.request(request)
+    # puts response.body
+    template =  REXML::XPath.first(REXML::Document.new(response.body), "//GetLoginDataTemplateResult").text
+    template.gsub!(/%NAME%/, @username)
+    template.gsub!(/%PASSWORD%/, @password)
+  end
+
+  # Fetches auth data by posting the login_template (got from call to get_login_template)
+  # to login_url (got from call to get_login_url)
+  # @param login_url [String] The login_url obtained from a previous call to get_login_url
+  # @param login_template [String] The login_template obtained from a previous call to get_login_template	
+  # @return [String] The auth_data received from server.
+  def get_auth_data(login_url, login_template)
+    uri = URI.parse(login_url)
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true
+    request = Net::HTTP::Post.new(login_url)
+
+    request.body = login_template
+    response = http.request(request)
+    @auth_data =  REXML::XPath.first(REXML::Document.new(response.body), "//Redirect").text
+    @auth_data.gsub!(/&/, "&") # rexml converts & to &. Convert them back to &
+  end
+
+  # Verifies if the auth_data obtained from the previous calls to get_auth_data is valid
+  # @return [String] returns true if auth_data is valid, nil otherwise
+  def verify_auth_data
+    http, request = get_request_headers("http://domains.live.com/Service/ManageDomain/V1.0/VerifyAuthData")
+    request.body = verify_auth_data_xml
+
+    # puts request.body
+    response = http.request(request)
+    # puts response.body
+    begin
+      authorized = REXML::XPath.first(REXML::Document.new(response.body), "//VerifyAuthDataResult").text
+    end
+    return authorized
+  end
+
+  # This method will add a member to the specified domain and provision an email account
+  # The member name is a email id of the member.
+  # Note that the corresponding domain should be already manually added and configured in the
+  # windows admin live center by logging on to the web interface.
+  #
+  # @param member_name [String] the complete email id of the member. eg. someone@example.com
+  #   Note that this domain should be already added and activated via the web interface at http://domains.live.com
+  # @param password [String] the desired password for the user/member.
+  # @param reset_password [Boolean] a true/false value whether we want member to be forced to change her
+  #  password on first login.
+  # @param first_name [String] first name of member
+  # @param last_name [String] last name of member
+  # @param lcid [Sting] member's locale ID. Can be blank or nil
+  # @return [Array] An [status, message] array where status is a true/false boolean indicating if create_member was
+  #   successful or not. message contains relevant error message if the status is false.
+  #
+  def create_member(member_name, password, reset_password, first_name, last_name, lcid=nil)
+    http, request = get_request_headers("http://domains.live.com/Service/ManageDomain/V1.0/CreateMember")
+
+    request.body = create_member_xml(member_name, password, reset_password, first_name, last_name, lcid)
+    #puts request.body
+    response = http.request(request)
+    # puts response.body
+
+    error = is_error?(response.body) # if response is an error xml, error string describes the error
+
+    if error # Response XML had in error node called ErrorDescription
+      return ["false", error]
+    else                 # Absence of ErrorDescription node is taken as success
+      return ["true", "Member #{first_name} #{last_name} (#{member_name}) successfully created."]
+    end
+
+  end # end method create_member
+  
+  # This method will delete a member given her member_name (email id)
+  # @param member_name [String] email id of the member
+  # @return [Array] An [status, message] array. status is the true/false boolean indicating if delete_member was
+  #   successful or not. message contains relevant error message if the status if false.
+  def delete_member(member_name)
+    http, request = get_request_headers("http://domains.live.com/Service/ManageDomain/V1.0/DeleteMember")
+
+    request.body = delete_member_xml(member_name)
+    #puts request.body
+    response = http.request(request)
+    # puts response.body
+
+    error = is_error?(response.body) # if response is an error, error is a string describing the error
+
+    if error # Response XML had in error node called ErrorDescription
+      return ["false", error]
+    else                 # Absence of ErrorDescription node is taken as success
+      return ["true", "Member #{member_name} successfully deleted."]
+    end
+
+  end # end method create_member
+
+  private
+  # Parses the response XML from the API calls and checks for the existence of error/fault nodes
+  # The presence of such nodes indicates there was a error. Error strings are extracted and returned
+  # in the response.
+  # This is an internal helper function
+  # @param [String] XML containing the response from the server for a particular request
+  # @return [String] returns false if this is not an error response, returns the error string otherwise
+  def is_error?(response_xml)
+    is_error_response =  REXML::XPath.first(REXML::Document.new(response_xml), "//faultstring")
+    if response_xml.nil?
+      return "Response is nil"
+    elsif is_error_response # Response XML has a error node called ErrorDescription
+      error = is_error_response.text
+      # check if there is an ErrorCode node
+      errorcode_node =  REXML::XPath.first(REXML::Document.new(response_xml), "//ErrorCode")
+      error = (errorcode_node.text + ": " + error) if errorcode_node # if there exists a errorcode node, append error code in error message
+      return error
+    else
+      return false # the response xml is not a error response
+    end
+  end # end is_error? method
+
+  # Generates the request headers for the HTTP request made by the API
+  # This is an internal helper function
+  # @param [String] Action URL of the API endpoint
+  # @return [Object, Object] returns the http and request object
+  def get_request_headers(action_url)
+    uri = URI.parse("https://domains.live.com")
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true
+    request = Net::HTTP::Post.new("/service/managedomain2.asmx")
+    request.add_field('Content-Type', 'text/xml; charset=utf-8')
+    request.add_field('SOAPAction', action_url)
+    return http, request
+  end
+
+end# end of class

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: windows_live_admin
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Shivam Patel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-20 00:00:00.000000000 Z
+dependencies: []
+description: Easy ruby wrapper of the Windows Live Admin API to easily domains, users
+  and their services (eg. outlook email inboxes).
+email: shivam@shivampatel.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/windows_live_admin.rb
+- lib/windows_live_admin/templates.rb
+homepage: http://msdn.microsoft.com/en-us/library/bb259710.aspx
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.0.6
+signing_key: 
+specification_version: 4
+summary: Windows Live Admin API wrapper
+test_files: []
+has_rdoc: