goldfinger 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee7cd56211208bae7616ba9a6b6535bcd358f676
-  data.tar.gz: d4bcfc1bd907072f3ef3062efd9e7644128a8779
+  metadata.gz: d87e2270742fca18ac73785d5099685f761a98e6
+  data.tar.gz: 437cc11a12334014e50d521dab4175d68e7d1fa9
 SHA512:
-  metadata.gz: 6787387b7f7130e0862a7205f8b277b9b017d8687cf6f2cb861c21fe0045c9db775107d7ce9f3dd5ade94d1b74955de0ec9911ddbae1cff23517a62175b58600
-  data.tar.gz: 2c7f7975273404131e0b4d2055ff2efd2f87a04f906a6cd065ef2b8af4b818d6413bbeeb7c0e4077b690fc61dd8312ce2c2eb554e3fabc1d3af8d48cf7eeb27c
+  metadata.gz: 1778395975ca01e8b288468035c3cbd6ccc1bc99c978f89a339399630695d085db6c0047b27a8e24f59deec0ae143867083f2d5cb2b8a46b8f22fe351528c891
+  data.tar.gz: c059dc6cac298573be5e7895dbe41adc6415a1afa80b006f6347970a16b80c83c9c6a8c23e2bb65102f23d6aa1167c236aafcb12ec4d7dba0e1971ab5a1581d3

data/README.md

@@ -14,9 +14,16 @@ A Webfinger client for Ruby. Supports `application/xrd+xml` and `application/jrd
 ## Usage
 
     data = Goldfinger.finger('acct:gargron@quitter.no')
-    data.link('http://schemas.google.com/g/2010#updates-from')[:href]
+
+    data.link('http://schemas.google.com/g/2010#updates-from').href
     # => "https://quitter.no/api/statuses/user_timeline/7477.atom"
 
+    data.aliases
+    # => ["https://quitter.no/user/7477", "https://quitter.no/gargron"]
+
+    data.subject
+    # => "acct:gargron@quitter.no"
+
 ## RFC support
 
-The gem only parses link data. It does not currently parse aliases, properties, or more complex structures.
+The official Webfinger RFC is [7033](https://tools.ietf.org/html/rfc7033).

data/lib/goldfinger.rb

@@ -1,4 +1,5 @@
 require 'goldfinger/request'
+require 'goldfinger/link'
 require 'goldfinger/result'
 require 'goldfinger/utils'
 require 'goldfinger/client'
@@ -13,6 +14,12 @@ module Goldfinger
   class SSLError < Error
   end
 
+  # Returns result for the Webfinger query
+  #
+  # @raise [Goldfinger::NotFoundError] Error raised when the Webfinger resource could not be retrieved
+  # @raise [Goldfinger::SSLError] Error raised when there was a SSL error when fetching the resource
+  # @param uri [String] A full resource identifier in the format acct:user@example.com
+  # @return [Goldfinger::Result]
   def self.finger(uri)
     Goldfinger::Client.new(uri).finger
   end

data/lib/goldfinger/client.rb

@@ -39,7 +39,7 @@ module Goldfinger
 
     def url_from_template(template)
       xml   = Nokogiri::XML(template)
-      links = xml.xpath('//xmlns:Link[@rel="lrdd"]', xmlns: 'http://docs.oasis-open.org/ns/xri/xrd-1.0')
+      links = xml.xpath('//xmlns:Link[@rel="lrdd"]')
 
       raise Goldfinger::NotFoundError if links.empty?
 

data/lib/goldfinger/link.rb

@@ -0,0 +1,53 @@
+module Goldfinger
+  # @!attribute [r] href
+  #   @return [String] The href the link points to
+  # @!attribute [r] type
+  #   @return [String] The mime type of the link
+  # @!attribute [r] rel
+  #   @return [String] The relation descriptor of the link
+  class Link
+    attr_reader :href, :type, :rel
+
+    def initialize(a)
+      @href       = a[:href]
+      @type       = a[:type]
+      @rel        = a[:rel]
+      @titles     = a[:titles]
+      @properties = a[:properties]
+    end
+
+    # The "titles" object comprises zero or more name/value pairs whose
+    # names are a language tag or the string "und".  The string is
+    # human-readable and describes the link relation.
+    # @see #title
+    # @return [Array] Array form of the hash
+    def titles
+      @titles.to_a
+    end
+
+    #  The "properties" object within the link relation object comprises
+    # zero or more name/value pairs whose names are URIs (referred to as
+    # "property identifiers") and whose values are strings or nil.
+    # Properties are used to convey additional information about the link
+    # relation.
+    # @see #property
+    # @return [Array] Array form of the hash
+    def properties
+      @properties.to_a
+    end
+
+    # Returns a title for a language
+    # @param lang [String]
+    # @return [String]
+    def title(lang)
+      @titles[lang]
+    end
+
+    # Returns a property for a key
+    # @param key [String]
+    # @return [String]
+    def property(key)
+      @properties[key]
+    end
+  end
+end

data/lib/goldfinger/result.rb

@@ -1,17 +1,57 @@
 module Goldfinger
   class Result
     def initialize(headers, body)
-      @mime_type = headers.get(HTTP::Headers::CONTENT_TYPE).first
-      @body      = body
-      @links     = {}
+      @mime_type  = headers.get(HTTP::Headers::CONTENT_TYPE).first
+      @body       = body
+      @subject    = nil
+      @aliases    = []
+      @links      = {}
+      @properties = {}
 
       parse
     end
 
+    # The value of the "subject" member is a URI that identifies the entity
+    # that the JRD describes.
+    # @return [String]
+    def subject
+      @subject
+    end
+
+    # The "aliases" array is an array of zero or more URI strings that
+    # identify the same entity as the "subject" URI.
+    # @return [Array]
+    def aliases
+      @aliases
+    end
+
+    # The "properties" object comprises zero or more name/value pairs whose
+    # names are URIs (referred to as "property identifiers") and whose
+    # values are strings or nil.
+    # @see #property
+    # @return [Array] Array form of the hash
+    def properties
+      @properties.to_a
+    end
+
+    # Returns a property for a key
+    # @param key [String]
+    # @return [String]
+    def property(key)
+      @properties[key]
+    end
+
+    # The "links" array has any number of member objects, each of which
+    # represents a link.
+    # @see #link
+    # @return [Array] Array form of the hash
     def links
       @links.to_a
     end
 
+    # Returns a key for a relation
+    # @param key [String]
+    # @return [Goldfinger::Link]
     def link(rel)
       @links[rel]
     end
@@ -29,13 +69,38 @@ module Goldfinger
 
     def parse_json
       json = JSON.parse(@body)
-      json['links'].each { |link| @links[link['rel']] = Hash[link.keys.map { |key| [key.to_sym, link[key]] }] }
+
+      @subject    = json['subject']
+      @aliases    = json['aliases'] || []
+      @properties = json['properties'] || {}
+
+      json['links'].each do |link|
+        tmp = Hash[link.keys.map { |key| [key.to_sym, link[key]] }]
+        @links[link['rel']] = Goldfinger::Link.new(tmp)
+      end
     end
 
     def parse_xml
       xml = Nokogiri::XML(@body)
-      links = xml.xpath('//xmlns:Link', xmlns: 'http://docs.oasis-open.org/ns/xri/xrd-1.0')
-      links.each { |link| @links[link.attribute('rel').value] = Hash[link.attributes.keys.map { |key| [key.to_sym, link.attribute(key).value] }] }
+
+      @subject = xml.at_xpath('//xmlns:Subject').content
+      @aliases = xml.xpath('//xmlns:Alias').map { |a| a.content }
+
+      properties = xml.xpath('/xmlns:XRD/xmlns:Property')
+      properties.each { |prop| @properties[prop.attribute('type').value] = prop.attribute('nil') ? nil : prop.content }
+
+      xml.xpath('//xmlns:Link').each do |link|
+        rel = link.attribute('rel').value
+        tmp = Hash[link.attributes.keys.map { |key| [key.to_sym, link.attribute(key).value] }]
+
+        tmp[:titles] = {}
+        tmp[:properties] = {}
+
+        link.xpath('.//xmlns:Title').each { |title| tmp[:titles][title.attribute('lang').value] = title.content }
+        link.xpath('.//xmlns:Property').each { |prop| tmp[:properties][prop.attribute('type').value] = prop.attribute('nil') ? nil : prop.content }
+
+        @links[rel] = Goldfinger::Link.new(tmp)
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: goldfinger
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Eugen Rochko
@@ -76,6 +76,7 @@ files:
 - README.md
 - lib/goldfinger.rb
 - lib/goldfinger/client.rb
+- lib/goldfinger/link.rb
 - lib/goldfinger/request.rb
 - lib/goldfinger/result.rb
 - lib/goldfinger/utils.rb