viewpoint-spws 0.5.0

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3@spws

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in viewpoint-spws.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

data/README.md

@@ -0,0 +1,75 @@
+Viewpoint for Sharepoint Web Services
+================================
+This is a Ruby client library for Sharepoint Web Services. If you've used my [Viewpoint library for Exchange Web Services](https://github.com/zenchild/Viewpoint) you will no doubt notice a similar feel to this library.  It however cannot be a one-for-one do to the way Sharepoint splits its web services among many different services.
+
+There is still quite a lot that needs to be done with the model layer. However, if you are a more daring personality the web service back-end is fairly complete for the web services I've chosen to expose thus far. I've also tried to document each back-end method to its fullest and to provide links to the Microsoft docs where I fall short. Documentation should be up to date on [rubydoc.info](http://rubydoc.info/github/zenchild/viewpoint-spws/frames).
+
+
+## Example Usage
+
+### Connecting
+```ruby
+require 'viewpoint/spws'
+site = 'https://myspsite/site_a/Default.aspx'
+# If using GSSAPI and the 'gssapi' gem you do not need to specify a user/pass
+scli = Viewpoint::SPWSClient.new(site)
+# Otherwise you can specify a user/pass
+scli = Viewpoint::SPWSClient.new(site, user, pass)
+```
+
+### Getting Lists
+```ruby
+# Retrieve all Lists for this site
+lists = scli.get_lists
+# Retrieve a specific list
+taskl = scli.get_list('Task List')
+# Retrieve a specific list by GUID
+mylist = scli.get_list('{9202CCD0-2EA7-012F-0C9A-58D3859A6B00}')
+```
+
+### Information about a List
+```ruby
+taskl.title
+# => "Task List" 
+taskl.description
+# => "Test Task List" 
+taskl.created
+# => #<DateTime: 2010-02-17T04:44:28+00:00 ((2455245j,17068s,0n),+0s,2299161j)> 
+taskl.modified 
+# => #<DateTime: 2012-01-09T06:03:25+00:00 ((2455936j,21805s,0n),+0s,2299161j)> 
+```
+
+### Retrieving Items
+```ruby
+# Retrieves an Array of Items
+tasks = taskl.items
+```
+
+### Creating/Renaming/Deleting a Task (other types of ListItems are forthcoming)
+```
+t1 = taskl.add_item!(:title => "New Task")
+# Set and call #save!
+t1.rename  'My New Task'
+t1.save!
+# or use the autosave method
+t1.rename! "My Really New Task"
+# or use an auto-saving transaction
+t1.update! do |l|
+  l.rename 'New Name'
+  l.set_priority :low
+  l.set_status :waiting
+end
+t1.delete!
+```
+
+### Upload a file to a DocumentLibrary List
+```ruby
+doclib = scli.get_list 'Personal Documents'
+doclib.add_file! :file => '/path/to/file'
+```
+
+### My Links
+- [Twitter | https://twitter.com/zentourist](https://twitter.com/#!/zentourist)
+- [BLOG | http://distributed-frostbite.blogspot.com/](http://distributed-frostbite.blogspot.com/)
+- [LinkedIn | http://www.linkedin.com/in/danwanek](http://www.linkedin.com/in/danwanek)
+- Find me on irc.freenode.net in #ruby-lang (zenChild)

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rubygems'
+
+desc "Clean the build environment"
+task :clean do
+    system "rm -f viewpoint*.gem"
+end

data/lib/extensions/string.rb

@@ -0,0 +1,35 @@
+=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
+
+# Custom extensions to the class String
+class String
+  # Change CamelCased strings to ruby_cased strings
+  # It uses the lookahead assertion ?=  In this case it basically says match
+  # anything followed by a capital letter, but not the capital letter itself.
+  # @see http://www.pcre.org/pcre.txt The PCRE guide for more details
+  def ruby_case
+    self.split(/(?=[A-Z])/).join('_').downcase
+  end
+
+  # Change a ruby_cased string to CamelCased
+  def camel_case
+    self.split(/_/).map { |i|
+      i.sub(/^./) { |s| s.upcase }
+    }.join
+  end
+end # String

data/lib/viewpoint/spws.rb

@@ -0,0 +1,63 @@
+=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
+require 'kconv' if(RUBY_VERSION.start_with? '1.9') # bug in rubyntlm with ruby 1.9.x
+require 'base64'
+require 'httpclient'
+require 'uri'
+require 'nokogiri'
+require 'logging'
+require 'pathname'
+
+# This is the base module for all other classes
+module Viewpoint
+  module SPWS
+    attr_reader :logger
+    Logging.logger.root.level = :info
+    Logging.logger.root.appenders = Logging.appenders.stdout
+
+    def self.root_logger
+      Logging.logger.root
+    end
+
+    def self.set_log_level(level)
+      Logging.logger.root.level = level
+    end
+  end
+end
+require 'viewpoint/spws/version'
+
+# ----- Monkey Patches -----
+require 'extensions/string'
+
+# ----- Library Files -----
+require 'viewpoint/spws/connection'
+require 'viewpoint/spws/websvc/web_service_base'
+# Copy Web Service
+require 'viewpoint/spws/websvc/copy'
+# Lists Web Service
+require 'viewpoint/spws/websvc/lists'
+require 'viewpoint/spws/types'
+require 'viewpoint/spws/types/list'
+require 'viewpoint/spws/types/tasks_list'
+require 'viewpoint/spws/types/document_library'
+require 'viewpoint/spws/types/list_item'
+# User and Groups Web Service
+require 'viewpoint/spws/websvc/user_group'
+require 'viewpoint/spws/types/user'
+
+require 'viewpoint/spws/spws_client'

data/lib/viewpoint/spws/connection.rb

@@ -0,0 +1,84 @@
+class Viewpoint::SPWS::Connection
+  include Viewpoint::SPWS
+
+  attr_reader :site_base
+  # @param [String] site_base the base URL of the site not including the
+  #   web service part.
+  #   @example https://<site>/mysite/<default.aspx>
+  def initialize(site_base)
+    @log = Logging.logger[self.class.name.to_s.to_sym]
+    @httpcli = HTTPClient.new
+    # Up the keep-alive so we don't have to do the NTLM dance as often.
+    @httpcli.keep_alive_timeout = 60
+    @site_base = URI.parse(normalize_site_name(site_base))
+  end
+
+  def set_auth(user,pass)
+    @httpcli.set_auth(@site_base.to_s, user, pass)
+  end
+
+  # Authenticate to the web service. You don't have to do this because
+  # authentication will happen on the first request if you don't do it here.
+  # @return [Boolean] true if authentication is successful, false otherwise
+  def authenticate(websvc)
+    self.get(websvc) && true
+  end
+
+  # Send a GET to the web service
+  # @return [String] If the request is successful (200) it returns the body of
+  #   the response.
+  def get(websvc)
+    check_response( @httpcli.get(@site_base + URI.encode(websvc)) )
+  end
+
+  # Send a POST to the web service
+  # @return [String] If the request is successful (200) it returns the body of
+  #   the response.
+  def post(websvc, xmldoc)
+    headers = {'Content-Type' => 'application/soap+xml; charset=utf-8'}
+    url = (@site_base + websvc).to_s
+    check_response( @httpcli.post(url, xmldoc, headers) )
+  end
+
+
+  private
+
+
+  # @param [String] site an unnormalized site
+  # @return [String] a normalized site base
+  def normalize_site_name(site)
+    site = site.sub(/default.aspx$/i,'')
+    site.end_with?('/') ? site : site << '/'
+  end
+
+  def check_response(resp)
+    @log.debug "HTTP Response: #{resp.status}"
+    case resp.status
+    when 200
+      resp.body
+    when 302
+      # @todo redirect
+      raise "Unhandled HTTP Redirect"
+    when 500
+      if resp.headers['Content-Type'].include?('xml')
+        err_string, err_code = parse_soap_error(resp.body)
+        raise "SOAP Error: Message: #{err_string}  Code: #{err_code}"
+      else
+        raise "Internal Server Error. Message: #{resp.body}"
+      end
+    else
+      raise "HTTP Error Code: #{resp.status}, Msg: #{resp.body}"
+    end
+  end
+
+  # @param [String] xml to parse the errors from.
+  def parse_soap_error(xml)
+    ndoc = Nokogiri::XML(xml)
+    ns = ndoc.collect_namespaces
+    err_string  = ndoc.xpath("//xmlns:errorstring",ns).text
+    err_code    = ndoc.xpath("//xmlns:errorcode",ns).text
+    @log.debug "Internal SOAP error. Message: #{err_string}, Code: #{err_code}"
+    [err_string, err_code]
+  end
+
+end