xrd 0.1.0

data/CHANGELOG

@@ -0,0 +1,3 @@
+== 0.1.0
+
+* initial release

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,36 @@
+# XRD
+
+<dl>
+  <dt>Homepage</dt><dd><a href="http://xrd.rubyforge.org/">http://xrd.rubyforge.org/</a></dd>
+  <dt>Author</dt><dd><a href="mailto:bobaman@google.com">Bob Aman</a></dd>
+  <dt>Copyright</dt><dd>Copyright © 2010 Google, Inc.</dd>
+  <dt>License</dt><dd>Apache 2.0</dd>
+</dl>
+
+# Description
+
+An XRD parser for Ruby.
+
+# Example Usage
+
+    require 'xrd'
+    xrd = XRD.fetch_and_parse(
+      'http://www.google.com/s2/webfinger/?q=acct%3Agooglebuzz%40gmail.com'
+    )
+    xrd.subject
+    # => #<Addressable::URI:0x80fb3864 URI:acct:googlebuzz@gmail.com>
+    xrd.aliases
+    # => [#<Addressable::URI:0x80fb3224 URI:http://www.google.com/profiles/googlebuzz>]
+    xrd.links(:media_type => 'application/atom+xml')
+    # => [#<XRD::Link:0x80fbc11c URI:https://www.googleapis.com/buzz/v1/activities/111062888259659218284/@public>]
+    xrd.links(:rel => 'describedby')
+    # => [
+    #   #<XRD::Link:0x80fbd224 URI:http://www.google.com/profiles/googlebuzz>,
+    #   #<XRD::Link:0x80fbc914 URI:http://www.google.com/s2/webfinger/?q=acct%3Agooglebuzz%40gmail.com&fmt=foaf>
+    # ]
+    xrd.links(:rel => 'describedby', :media_type => 'text/html')
+    # => [#<XRD::Link:0x80fbd224 URI:http://www.google.com/profiles/googlebuzz>]
+
+# Install
+
+* sudo gem install xrd

data/Rakefile

@@ -0,0 +1,59 @@
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__), 'lib'))
+$:.unshift(lib_dir)
+$:.uniq!
+
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/contrib/rubyforgepublisher'
+
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  STDERR.puts 'Please install rspec:'
+  STDERR.puts 'sudo gem install rspec'
+  exit(1)
+end
+
+require File.join(File.dirname(__FILE__), 'lib/xrd', 'version')
+
+PKG_DISPLAY_NAME   = 'XRD'
+PKG_NAME           = PKG_DISPLAY_NAME.downcase
+PKG_VERSION        = XRD::VERSION::STRING
+PKG_FILE_NAME      = "#{PKG_NAME}-#{PKG_VERSION}"
+
+RELEASE_NAME       = "REL #{PKG_VERSION}"
+
+RUBY_FORGE_PROJECT = PKG_NAME
+RUBY_FORGE_USER    = 'sporkmonger'
+RUBY_FORGE_PATH    = "/var/www/gforge-projects/#{RUBY_FORGE_PROJECT}"
+RUBY_FORGE_URL     = "http://#{RUBY_FORGE_PROJECT}.rubyforge.org/"
+
+PKG_AUTHOR         = 'Bob Aman'
+PKG_AUTHOR_EMAIL   = 'bob@sporkmonger.com'
+PKG_HOMEPAGE       = RUBY_FORGE_URL
+PKG_SUMMARY        = 'Package Summary'
+PKG_DESCRIPTION    = <<-TEXT
+An XRD parser and generator for Ruby.
+TEXT
+
+PKG_FILES = FileList[
+    'lib/**/*', 'spec/**/*', 'vendor/**/*',
+    'tasks/**/*', 'website/**/*',
+    '[A-Z]*', 'Rakefile'
+].exclude(/database\.yml/).exclude(/[_\.]git$/)
+
+RCOV_ENABLED = (RUBY_PLATFORM != 'java' && RUBY_VERSION =~ /^1\.8/)
+if RCOV_ENABLED
+  task :default => 'spec:verify'
+else
+  task :default => 'spec'
+end
+
+WINDOWS = (RUBY_PLATFORM =~ /mswin|win32|mingw|bccwin|cygwin/) rescue false
+SUDO = WINDOWS ? '' : ('sudo' unless ENV['SUDOLESS'])
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/lib/xrd.rb

@@ -0,0 +1,30 @@
+# Copyright 2010 Google, Inc.
+# 
+#    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.
+
+require 'xrd/version'
+require 'xrd/resource_descriptor'
+
+require 'httpadapter'
+require 'httpadapter/adapters/net_http'
+
+module XRD
+  def self.parse(xml)
+    return XRD::ResourceDescriptor.parse(xml)
+  end
+
+  def self.fetch_and_parse(
+      uri, adapter=HTTPAdapter::NetHTTPRequestAdapter, connection=nil)
+    return XRD::ResourceDescriptor.fetch_and_parse(uri, adapter, connection)
+  end
+end

data/lib/xrd/link.rb

@@ -0,0 +1,46 @@
+require 'sax-machine'
+require 'addressable/uri'
+require 'xrd/properties'
+require 'xrd/title'
+
+module XRD
+  class Link
+    include SAXMachine
+    include XRD::Properties
+
+    element "Link", :as => :rel, :value => "rel"
+    element "Link", :as => :media_type, :value => "type"
+    element "Link", :as => :href, :value => "href"
+    element "Link", :as => :template, :value => "template"
+    elements "Title", :as => :titles, :class => XRD::Title
+
+    def title(lang=nil)
+      title = self.titles.detect { |t| t.lang == lang }
+      unless title
+        title = self.titles.detect { |t| t.lang == nil }
+      end
+      unless title
+        title = self.titles.detect { |t| t.lang == 'en' }
+      end
+      return title
+    end
+
+    ##
+    # Returns a <code>String</code> representation of the link object's state.
+    #
+    # @return [String] The Link object's state, as a <code>String</code>.
+    def inspect
+      if self.template
+        sprintf(
+          "#<%s:%#0x TEMPLATE:%s>",
+          self.class.to_s, self.object_id, self.template
+        )
+      else
+        sprintf(
+          "#<%s:%#0x HREF:%s>",
+          self.class.to_s, self.object_id, self.href
+        )
+      end
+    end
+  end
+end

data/lib/xrd/properties.rb

@@ -0,0 +1,62 @@
+require 'sax-machine'
+require 'addressable/uri'
+
+module XRD
+  module Properties
+    def self.included(base)
+      base.send :include, SAXMachine
+      base.send :elements, "Property", :as => :property_values
+      base.send :elements, "Property", :as => :property_keys, :value => "type"
+      base.send(:elements, "Property",
+        :as => :property_nils, :value => "xsi:nil")
+
+      base.send(:remove_method,
+        :property_keys, :property_keys=, :add_property_keys
+      )
+      base.send(:remove_method,
+        :property_values, :property_values=, :add_property_values
+      )
+      base.send(:remove_method,
+        :property_nils, :property_nils=, :add_property_nils
+      )
+    end
+
+    def properties
+      return @properties ||= []
+    end
+
+  protected
+    def add_property_keys(new_property_key)
+      @new_property_key = Addressable::URI.parse(new_property_key)
+      merge_and_add_property()
+      return @new_property_key
+    end
+
+    def add_property_values(new_property_value)
+      @new_property_value = new_property_value
+      merge_and_add_property()
+      return @new_property_value
+    end
+
+    def add_property_nils(new_property_value)
+      # If xsi:nil is set to anything but 'true', ignore it.
+      if new_property_value == "true"
+        # Hack to detect when we've set this to nil
+        @new_property_value = :nil
+        merge_and_add_property()
+        return @new_property_value
+      end
+    end
+
+    def merge_and_add_property
+      if @new_property_key && @new_property_value
+        self.properties << [
+          Addressable::URI.parse(@new_property_key),
+          @new_property_value == :nil ? nil : @new_property_value
+        ]
+        @new_property_key, @new_property_value = nil, nil
+      end
+      return nil
+    end
+  end
+end