viewpoint-spws 0.5.0

data/lib/viewpoint/spws/websvc/user_group.rb

@@ -0,0 +1,96 @@
+=begin
+  This file is part of ViewpointSPWS; the Ruby library for Microsoft Sharepoint Web Services.
+
+  Copyright © 2011 Dan Wanek <dan.wanek@gmail.com>
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+=end
+
+# This class represents the Sharepoint User and Groups Web Service.
+# @see http://msdn.microsoft.com/en-us/library/ms772647(v=office.12).aspx
+class Viewpoint::SPWS::Websvc::UserGroup
+  include Viewpoint::SPWS::Websvc::WebServiceBase
+
+  def initialize(spcon)
+    @default_ns = 'http://schemas.microsoft.com/sharepoint/soap/directory/'
+    @ws_endpoint = '_vti_bin/UserGroup.asmx'
+    super
+  end
+
+  def get_all_user_collection_from_web
+    soapmsg = build_soap_envelope do |type, builder|
+      if(type == :header)
+      else
+        builder.GetAllUserCollectionFromWeb {
+          builder.parent.default_namespace = @default_ns
+        }
+      end
+    end
+    soaprsp = Nokogiri::XML(send_soap_request(soapmsg.doc.to_xml))
+    ns = {'xmlns' => @default_ns}
+    users = []
+    soaprsp.xpath('//xmlns:Users/xmlns:User', ns).each do |li|
+      users << Types::User.new(self,li)
+    end
+    users
+  end
+
+  # Returns information about a specified user
+  # @param [String] user A username to retrieve infor for. It must be of the form
+  #   DOMAIN\username
+  def get_user_info(user)
+    soapmsg = build_soap_envelope do |type, builder|
+      if(type == :header)
+      else
+        builder.GetUserInfo {
+          builder.parent.default_namespace = @default_ns
+          builder.userLoginName(user)
+        }
+      end
+    end
+    soaprsp = Nokogiri::XML(send_soap_request(soapmsg.doc.to_xml))
+    ns = {'xmlns' => @default_ns}
+    user = soaprsp.xpath('//xmlns:GetUserInfo/xmlns:User', ns).first
+    Types::User.new(self,user)
+  end
+
+  # Get user logins from e-mail addresses
+  # @see http://msdn.microsoft.com/en-us/library/ms774890(v=office.12).aspx
+  # @param [Array<String>] emails an Array of e-mail addresses to search for
+  # @return [Hash] a hash of email to login mappings
+  def get_user_login_from_email(emails)
+    soapmsg = build_soap_envelope do |type, builder|
+      if(type == :header)
+      else
+        builder.GetUserLoginFromEmail {
+          builder.parent.default_namespace = @default_ns
+          builder.emailXml {
+            builder.Users {
+              emails.each do |email|
+                builder.User(:Email => email)
+              end
+            }
+          }
+        }
+      end
+    end
+    soaprsp = Nokogiri::XML(send_soap_request(soapmsg.doc.to_xml))
+    ns = {'xmlns' => @default_ns}
+    logins = {}
+    soaprsp.xpath('//xmlns:GetUserLoginFromEmail/xmlns:User', ns).each do |li|
+      logins[li['Email']] = li['Login']
+    end
+    logins
+  end
+
+end

data/lib/viewpoint/spws/websvc/web_service_base.rb

@@ -0,0 +1,65 @@
+=begin
+  This file is part of ViewpointSPWS; the Ruby library for Microsoft Sharepoint Web Services.
+
+  Copyright © 2011 Dan Wanek <dan.wanek@gmail.com>
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+=end
+
+# This module represents the common elements of Sharepoint Web Services
+module Viewpoint::SPWS::Websvc
+  module WebServiceBase
+    include Viewpoint::SPWS
+
+    NAMESPACES = {
+      'xmlns:soap'  => 'http://www.w3.org/2003/05/soap-envelope',
+      'xmlns:xsi'   => 'http://www.w3.org/2001/XMLSchema-instance',
+      'xmlns:xsd'   => 'http://www.w3.org/2001/XMLSchema',
+    }.freeze
+
+    attr_reader :spcon
+
+    # @param [Viewpoint::SPWS::Connection] spcon A connection to a Sharepoint Site
+    def initialize(spcon)
+      @log = Logging.logger[self.class.name.to_s.to_sym]
+      @spcon = spcon
+      raise "Auth failure" unless(@spcon.authenticate(@ws_endpoint))
+    end
+
+    private
+
+    def build_soap_envelope
+      new_ent = Nokogiri::XML::Builder.new do |xml|
+        xml.Envelope(NAMESPACES) do |ent|
+          xml.parent.namespace = xml.parent.namespace_definitions.find{|ns|ns.prefix=="soap"}
+          ent['soap'].Header {
+            yield(:header, ent) if block_given?
+          }
+          ent['soap'].Body {
+            yield(:body, ent) if block_given?
+          }
+        end
+      end
+    end
+
+    # Send the SOAP request to the endpoint
+    # @param [String] soapmsg an XML formatted string
+    def send_soap_request(soapmsg)
+      @log.debug "Sending SOAP Request:\n----------------\n#{soapmsg}\n----------------"
+      respmsg = @spcon.post(@ws_endpoint, soapmsg)
+      @log.debug "Received SOAP Response:\n----------------\n#{Nokogiri::XML(respmsg).to_xml}\n----------------"
+      respmsg
+    end
+
+  end
+end

data/preamble

@@ -0,0 +1,17 @@
+=begin
+  This file is part of ViewpointSPWS; the Ruby library for Microsoft Sharepoint Web Services.
+
+  Copyright © 2011 Dan Wanek <dan.wanek@gmail.com>
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+=end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+$: << File.dirname(__FILE__) + '/../lib/'
+require 'yaml'
+require 'date'
+require 'viewpoint/spws'
+
+# To run these tests put configuration into a file called site_info.yaml
+# --- 
+# :site: sp_site_base
+# :user: user
+# :pass: pass
+
+module SpecHelper
+  def self.specdir
+    File.dirname(__FILE__)
+  end
+end
+
+RSpec.configure do |config|
+  config.before(:all) do
+    @conf = YAML.load(File.open("#{SpecHelper.specdir}/site_info.yaml",'r'))
+  end
+end

data/spec/spws_client_spec.rb

@@ -0,0 +1,43 @@
+$: << File.dirname(__FILE__)
+require 'spec_helper'
+
+describe 'Test the Sharepoint List web service functionality' do
+  before(:all) do
+    @scli = Viewpoint::SPWSClient.new(@conf[:site], @conf[:user], @conf[:pass])
+  end
+
+  it 'should return the Lists web service' do
+    @scli.lists_ws.should be_an_instance_of Viewpoint::SPWS::Websvc::Lists
+  end
+
+  it 'should return the Copy web service' do
+    @scli.copy_ws.should be_an_instance_of Viewpoint::SPWS::Websvc::Copy
+  end
+
+  it 'should return the UserGroup web service' do
+    @scli.usergroup_ws.should be_an_instance_of Viewpoint::SPWS::Websvc::UserGroup
+  end
+
+  it 'should retrieve the Lists from a given Sharepoint site' do
+    lists = @scli.get_lists
+    lists.should be_an_instance_of(Array)
+    lists.first.should be_a_kind_of(Viewpoint::SPWS::Types::List)
+  end
+
+  it 'should retrieve the Items from a given List' do
+    lists = @scli.get_lists
+    items = lists.first.items
+    items.should be_an_instance_of(Array)
+  end
+
+  it 'should retrieve a User given a domain login' do
+    u = @scli.get_user @conf[:user_login]
+    u.should be_an_instance_of(Viewpoint::SPWS::Types::User)
+  end
+
+  it 'should retrieve a User given an e-mail' do
+    u = @scli.get_user @conf[:user_email]
+    u.should be_an_instance_of(Viewpoint::SPWS::Types::User)
+  end
+
+end

data/viewpoint-spws.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "viewpoint/spws/version"
+
+Gem::Specification.new do |s|
+  s.name        = "viewpoint-spws"
+  s.version     = Viewpoint::SPWS::VERSION
+  s.date        = Date.today.to_s
+  s.author      = "Dan Wanek"
+  s.email       = "dan.wanek@gmail.com"
+  s.homepage    = "http://github.com/zenchild/viewpoint-spws"
+  s.summary     = "A Ruby client access library for Microsoft Sharepoint Web Services (SPWS)"
+  s.description = %q{TODO: Write a gem description}
+  s.description	= <<-EOF
+    A Ruby client access library for Microsoft Sharepoint Web Services (SPWS).  It is a work in progress.  Methods are still being added from the Sharepoint API docs.
+  EOF
+  s.required_ruby_version = '>= 1.8.7'
+
+  s.rubyforge_project = nil
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.rdoc_options  = %w(-x spec/)
+  s.extra_rdoc_files = %w(README.md LICENSE)
+
+  s.add_runtime_dependency  'nokogiri',   '~> 1.5.0'
+  s.add_runtime_dependency  'httpclient', '~> 2.2.4'
+  s.add_runtime_dependency  'logging',    '~> 1.6.1'
+  s.add_runtime_dependency  'rubyntlm'
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: viewpoint-spws
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+  prerelease: 
+platform: ruby
+authors:
+- Dan Wanek
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &11969560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *11969560
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: &11969100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *11969100
+- !ruby/object:Gem::Dependency
+  name: logging
+  requirement: &11968540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *11968540
+- !ruby/object:Gem::Dependency
+  name: rubyntlm
+  requirement: &11968100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *11968100
+description: ! '    A Ruby client access library for Microsoft Sharepoint Web Services
+  (SPWS).  It is a work in progress.  Methods are still being added from the Sharepoint
+  API docs.
+
+'
+email: dan.wanek@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/extensions/string.rb
+- lib/viewpoint/spws.rb
+- lib/viewpoint/spws/connection.rb
+- lib/viewpoint/spws/spws_client.rb
+- lib/viewpoint/spws/types.rb
+- lib/viewpoint/spws/types/document_library.rb
+- lib/viewpoint/spws/types/list.rb
+- lib/viewpoint/spws/types/list_item.rb
+- lib/viewpoint/spws/types/tasks_list.rb
+- lib/viewpoint/spws/types/user.rb
+- lib/viewpoint/spws/version.rb
+- lib/viewpoint/spws/websvc/copy.rb
+- lib/viewpoint/spws/websvc/lists.rb
+- lib/viewpoint/spws/websvc/user_group.rb
+- lib/viewpoint/spws/websvc/web_service_base.rb
+- preamble
+- spec/spec_helper.rb
+- spec/spws_client_spec.rb
+- viewpoint-spws.gemspec
+homepage: http://github.com/zenchild/viewpoint-spws
+licenses: []
+post_install_message: 
+rdoc_options:
+- -x
+- spec/
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A Ruby client access library for Microsoft Sharepoint Web Services (SPWS)
+test_files: []