sucker 1.4.0 → 1.4.1

data/lib/sucker/response.rb

@@ -3,13 +3,13 @@ require 'sucker/hash'
 
 module Sucker
 
-  # A wrapper around the response
+  # A wrapper around the API response.
   class Response
 
-    # The response body
+    # The response body.
     attr_accessor :body
 
-    # The HTTP status code of the response
+    # The HTTP status code of the response.
     attr_accessor :code
 
     def initialize(response)
@@ -17,61 +17,66 @@ module Sucker
       self.code = response.code
     end
 
-    # A shorthand that yields each match to a block
+    # A shorthand that queries for a specified attribute and yields to a given
+    # block each matching document.
     #
     #   response.each('Item') { |item| process_item(item) }
     #
-    def each(path)
-      find(path).each { |match| yield match }
+    def each(path, &block)
+      find(path).each { |match| block.call(match) }
     end
 
-    # Returns an array of errors in the reponse
+    # Returns an array of errors in the response.
     def errors
       find('Error')
     end
 
-    # Queries an xpath and returns an array of matching nodes
+    # Queries for a specified attribute and returns an array of matching
+    # documents.
     #
     #   items = response.find('Item')
     #
-    def find(path)
-      xml.xpath("//xmlns:#{path}").map { |element| Hash.from_xml(element) }
+    def find(attribute)
+      xml.xpath("//xmlns:#{attribute}").map do |element|
+        Hash.from_xml(element)
+      end
     end
-
     alias_method :[], :find
 
-    # Returns true if response contains errors
+    # Returns true if the response contains errors.
     def has_errors?
       errors.count > 0
     end
 
-    # A shorthand that yields matches to a block and collects returned values
+    # A shorthand that queries for a specifed attribute, yields to a given
+    # block matching documents, and collects final values.
     #
-    #   descriptions = response.map('Item') { |item| build_description(item) }
+    #   items = response.map('Item') { |item| # do something }
     #
-    def map(path)
-      find(path).map { |match| yield match }
+    def map(path, &block)
+      find(path).map { |match| block.call(match) }
     end
 
-    # Parses response into a simple hash
+    # Parses the response into a simple hash.
     def to_hash
       Hash.from_xml(xml)
     end
 
-    # Checks if the HTTP response is OK
+    # Checks if the HTTP response is OK.
     #
     #    response = worker.get
-    #    p response.valid?
+    #    response.valid?
     #    => true
     #
     def valid?
       code == '200'
     end
 
-    # The XML document
+    # The XML document.
     #
     #    response = worker.get
     #    response.xml
+    #
     def xml
       @xml ||= Nokogiri::XML(body)
     end

data/lib/sucker/response.rbc

@@ -9,7 +9,7 @@ x
 10
 __script__
 i
-37
+46
 5
 7
 0
@@ -19,30 +19,39 @@ i
 1
 1
 15
-99
+5
 7
 2
-65
+64
+47
 49
+1
+1
+15
+99
+7
 3
+65
+49
+4
 2
 13
 99
 12
 7
-4
+5
 12
 7
-5
+6
 12
 65
 12
 49
-6
+7
 4
 15
 49
-4
+5
 0
 15
 2
@@ -57,13 +66,16 @@ I
 0
 n
 p
-7
+8
 s
-32
-active_support/xml_mini/nokogiri
+8
+nokogiri
 x
 7
 require
+s
+11
+sucker/hash
 x
 6
 Sucker
@@ -139,7 +151,7 @@ x
 8
 Response
 i
-134
+154
 5
 66
 5
@@ -214,11 +226,21 @@ i
 6
 4
 15
-99
+5
 7
 13
 7
+11
+47
+49
 14
+2
+15
+99
+7
+15
+7
+16
 65
 67
 49
@@ -230,9 +252,9 @@ i
 15
 99
 7
-15
+17
 7
-16
+18
 65
 67
 49
@@ -244,9 +266,9 @@ i
 15
 99
 7
-17
+19
 7
-18
+20
 65
 67
 49
@@ -256,15 +278,25 @@ i
 6
 4
 15
+99
+7
+21
+7
+22
+65
+67
+49
 5
-48
-19
+0
+49
+6
+4
 15
 99
 7
-20
+23
 7
-21
+24
 65
 67
 49
@@ -284,7 +316,7 @@ I
 0
 n
 p
-22
+25
 x
 4
 body
@@ -364,23 +396,23 @@ p
 I
 -1
 I
-10
+f
 I
 0
 I
-58
+50
 I
 1
 I
-11
+10
 I
 f
 I
-58
+50
 I
 10
 I
-12
+11
 I
 1e
 x
@@ -398,6 +430,118 @@ x
 15
 add_defn_method
 x
+4
+each
+M
+1
+n
+n
+x
+4
+each
+i
+13
+5
+20
+0
+47
+49
+0
+1
+56
+1
+50
+2
+0
+11
+I
+3
+I
+1
+I
+1
+I
+1
+n
+p
+3
+x
+4
+find
+M
+1
+p
+2
+x
+9
+for_block
+t
+n
+x
+4
+each
+i
+9
+57
+19
+0
+15
+20
+0
+60
+1
+11
+I
+3
+I
+1
+I
+1
+I
+1
+n
+p
+0
+p
+3
+I
+0
+I
+19
+I
+9
+x
+53
+/Users/hakanensari/code/sucker/lib/sucker/response.rb
+p
+1
+x
+5
+match
+x
+4
+each
+p
+5
+I
+-1
+I
+18
+I
+0
+I
+19
+I
+d
+x
+53
+/Users/hakanensari/code/sucker/lib/sucker/response.rb
+p
+1
+x
+4
+path
+x
 6
 errors
 M
@@ -440,11 +584,11 @@ p
 I
 -1
 I
-16
+1d
 I
 0
 I
-17
+1e
 I
 9
 x
@@ -521,30 +665,22 @@ x
 4
 find
 i
-21
+13
 57
 19
 0
 15
-5
-20
-0
-49
-0
+45
 0
-21
 1
+20
 0
 49
-1
-1
-47
-49
 2
 1
 11
 I
-5
+4
 I
 1
 I
@@ -555,30 +691,28 @@ n
 p
 3
 x
-7
-to_hash
-x
-2
-[]
+4
+Hash
+n
 x
-13
-strip_content
+8
+from_xml
 p
 3
 I
 0
 I
-20
+26
 I
-15
+d
 x
 53
 /Users/hakanensari/code/sucker/lib/sucker/response.rb
 p
 1
 x
-1
-e
+7
+element
 x
 3
 map
@@ -587,11 +721,11 @@ p
 I
 -1
 I
-1f
+25
 I
 0
 I
-20
+26
 I
 15
 x
@@ -603,6 +737,12 @@ x
 4
 path
 x
+2
+[]
+x
+12
+alias_method
+x
 11
 has_errors?
 M
@@ -649,11 +789,11 @@ p
 I
 -1
 I
-24
+2c
 I
 0
 I
-25
+2d
 I
 a
 x
@@ -662,153 +802,138 @@ x
 p
 0
 x
-7
-to_hash
+3
+map
 M
 1
 n
 n
 x
-7
-to_hash
+3
+map
 i
-12
-5
+13
 5
-48
-0
-49
-1
+20
 0
 47
 49
-2
+0
 1
+56
+1
+50
+2
+0
 11
 I
-2
+3
 I
-0
+1
 I
-0
+1
 I
-0
+1
 n
 p
 3
 x
-3
-xml
-x
-7
-to_hash
-x
-13
-strip_content
-p
-5
-I
--1
-I
-2d
-I
-0
-I
-2e
-I
-c
-x
-53
-/Users/hakanensari/code/sucker/lib/sucker/response.rb
-p
-0
-x
-6
-valid?
+4
+find
 M
 1
-n
+p
+2
+x
+9
+for_block
+t
 n
 x
-6
-valid?
+3
+map
 i
 9
-5
-48
+57
+19
 0
-7
+15
+20
+0
+60
 1
-64
-83
-2
 11
 I
-2
+3
 I
-0
+1
 I
-0
+1
 I
-0
+1
 n
 p
+0
+p
 3
+I
+0
+I
+36
+I
+9
 x
-4
-code
-s
-3
-200
+53
+/Users/hakanensari/code/sucker/lib/sucker/response.rb
+p
+1
 x
-2
-==
+5
+match
+x
+3
+map
 p
 5
 I
 -1
 I
-37
+35
 I
 0
 I
-38
+36
 I
-9
+d
 x
 53
 /Users/hakanensari/code/sucker/lib/sucker/response.rb
 p
-0
+1
 x
-3
-xml
+4
+path
+x
+7
+to_hash
 M
 1
 n
 n
 x
-3
-xml
+7
+to_hash
 i
-18
-39
-0
-13
 10
-17
-15
 45
+0
 1
-2
 5
 48
-3
+2
 49
-4
+3
 1
-38
-0
 11
 I
 2
@@ -820,462 +945,217 @@ I
 0
 n
 p
-5
-x
 4
-@xml
-x
-8
-Nokogiri
-n
 x
 4
-body
+Hash
+n
 x
 3
-XML
+xml
+x
+8
+from_xml
 p
 5
 I
 -1
 I
-3f
+3a
 I
 0
 I
-40
+3b
 I
-12
+a
 x
 53
 /Users/hakanensari/code/sucker/lib/sucker/response.rb
 p
 0
 x
-7
-private
-x
-13
-strip_content
+6
+valid?
 M
 1
 n
 n
 x
-13
-strip_content
+6
+valid?
 i
-88
-20
-0
-13
-45
-0
-1
-12
-49
-2
-1
-9
-22
-15
-20
-0
-56
-3
-50
-4
-0
 8
-87
-13
-45
 5
-6
-12
-49
-2
-1
-9
-84
-15
-20
-0
-49
-7
-0
-49
-8
+48
 0
-79
+4
+200
 83
-9
-13
-9
-56
-15
-20
-0
-7
-10
-64
-49
-11
-1
-9
-68
-20
-0
-7
-10
-64
-49
-11
-1
-8
-82
-20
-0
-44
-43
-5
-78
-49
-12
-1
-56
-13
-50
-14
 1
-8
-87
-15
-20
-0
 11
 I
-4
+2
 I
-1
+0
 I
-1
+0
 I
-1
-n
-p
-15
-x
-5
-Array
+0
 n
-x
-3
-===
-M
-1
 p
 2
 x
-9
-for_block
-t
-n
+4
+code
 x
-13
-strip_content
-i
-12
-57
-19
-0
-15
+2
+==
+p
 5
-20
-0
-47
-49
-0
-1
-11
-I
-4
-I
-1
 I
-1
+-1
 I
-1
-n
-p
-1
-x
-13
-strip_content
-p
-3
+44
 I
 0
 I
-49
+45
 I
-c
+8
 x
 53
 /Users/hakanensari/code/sucker/lib/sucker/response.rb
 p
-1
-x
-5
-child
+0
 x
 3
-map
-x
-4
-Hash
-n
-x
-4
-keys
-x
-4
-size
-x
-2
-==
-s
-11
-__content__
-x
-2
-[]
-x
-16
-new_from_literal
+xml
 M
 1
-p
-2
-x
-9
-for_block
-t
+n
 n
 x
-13
-strip_content
+3
+xml
 i
-51
-58
-37
-19
+21
+39
 0
-15
-37
-19
-1
-15
-15
+13
+10
 20
-1
-97
-37
-19
-2
-15
-37
-19
-3
-15
 15
-2
-15
-20
-0
-44
-43
-0
-79
-49
-1
+45
 1
-13
-20
 2
 5
-20
-3
-47
-49
-2
-1
-49
+48
 3
-2
-15
 49
 4
+0
+49
+5
 1
+38
+0
 11
 I
-b
+2
 I
-4
+0
 I
-2
+0
 I
-2
+0
 n
 p
-5
+6
 x
 4
-Hash
-x
-16
-new_from_literal
-x
-13
-strip_content
-x
-3
-[]=
+@xml
 x
-5
-merge
-p
-7
-I
-0
-I
-4e
-I
-a
-I
-4f
-I
-18
-I
-50
-I
-33
+8
+Nokogiri
+n
 x
-53
-/Users/hakanensari/code/sucker/lib/sucker/response.rb
-p
 4
+body
 x
-10
-attributes
-x
-2
-kv
-x
-1
-k
-x
-1
-v
+4
+dump
 x
-6
-inject
+3
+XML
 p
-19
+5
 I
 -1
 I
-46
-I
-0
-I
-47
-I
-2
-I
-48
-I
-d
-I
-49
-I
-16
-I
-4a
-I
-21
-I
-4b
-I
-3a
-I
 4c
 I
-44
-I
-4e
-I
-55
+0
 I
-54
+4d
 I
-58
+15
 x
 53
 /Users/hakanensari/code/sucker/lib/sucker/response.rb
 p
-1
-x
-4
-node
+0
 p
-23
+25
 I
 2
 I
-b
+a
 I
 a
 I
-e
+d
 I
 12
 I
-10
+f
 I
 20
 I
-16
+18
 I
 2e
 I
-1f
+1d
 I
 3c
 I
-24
+25
 I
 4a
 I
-2d
+29
 I
-58
+54
 I
-37
+2c
 I
-66
+62
 I
-3f
+35
 I
-74
+70
 I
-43
+3a
 I
-78
+7e
 I
-46
+44
+I
+8c
+I
+4c
 I
-86
+9a
 x
 53
 /Users/hakanensari/code/sucker/lib/sucker/response.rb
@@ -1289,7 +1169,7 @@ p
 I
 2
 I
-8
+7
 I
 1d
 x
@@ -1301,17 +1181,21 @@ x
 13
 attach_method
 p
-5
+7
 I
 0
 I
-3
+1
 I
 9
 I
-5
+2
 I
-25
+12
+I
+4
+I
+2e
 x
 53
 /Users/hakanensari/code/sucker/lib/sucker/response.rb