smg 0.1.0 → 0.2.0

data/README.rdoc

@@ -6,72 +6,16 @@ Backed by Nokogiri's SAX Parser.
 == FEATURES:
 
 * Typecasting
-* Nested resources (aka has_one)
-* Collections (aka has_many)
+* Nested resources
+* Collections
+* Conditions
 * Contextual parsing
+* HTTP interaction
 
 == EXAMPLES:
 
-=== Twitter
-
-  class Status
-    include SMG::Resource
-
-    root 'status'
-
-    extract :id         , :class => :integer, :as => :status_id
-    extract :created_at , :class => :datetime
-    extract :text
-
-  end
-
-  class User
-    include SMG::Resource
-
-    root 'user'
-
-    extract :id                 , :class => :integer, :as => :twitter_id
-    extract :location           , :class => :string
-    extract :status             , :class => Status
-    extract :created_at         , :class => :datetime
-    extract :name
-    extract :screen_name
-
-  end
-
-=== discogs.com (with context)
-
-  class Label
-
-    class Release
-
-      include SMG::Resource
-
-      extract :release  , :at => :id, :as => :discogs_id, :class => :integer
-      extract :release  , :at => :status
-
-      extract 'release/title'
-      extract 'release/catno'
-      extract 'release/artist'
-
-    end
-
-    include SMG::Resource
-
-    root 'resp/label'
-    extract :name
-    extract :profile
-    collect 'releases/release'  , :as => :releases, :class => Release, :context => [:with_releases]
-
-  end
-
-  label = Label.parse(xml)
-  label.name #=> "name of the label"
-  label.releases #=> []
-
-  label = Label.parse(xml, :with_releases)
-  label.name #=> "name of the label"
-  label.releases #=> [#<Label::Release...>, ... #<Label::Release...>]
+See examples directory:
+http://github.com/SSDany/smg/tree/master/examples
 
 == REQUIREMENTS:
 

data/examples/discogs/label.rb

@@ -0,0 +1,62 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'helper'))
+
+module Discogs
+  class Label
+
+    class Release
+
+      include SMG::Resource
+
+      extract 'release' , :at => :id, :as => :discogs_id, :class => :integer
+      extract 'release' , :at => :status
+
+      extract 'release/title'
+      extract 'release/catno'
+      extract 'release/artist'
+      extract 'release/format'
+
+    end
+
+    include SMG::Resource
+
+    root 'resp/label'
+
+    extract 'name'
+    extract 'contactinfo'       , :as => :contacts
+    extract 'profile'
+    extract 'parentLabel'       , :as => :parent
+    collect 'urls/url'          , :as => :links
+    collect 'sublabels/label'   , :as => :sublabels
+    collect 'releases/release'  , :as => :releases, :class => Release , :context => [:releases], :with => {"status" => "Accepted"}
+
+    def name_with_parent
+      "#{name}#{" @ #{parent}" if parent}"
+    end
+
+  end
+end
+
+data = File.read(ROOT.join('spec/fixtures/discogs/Enzyme+Records.xml'))
+
+template = <<-TEMPLATE
+<%= label.name_with_parent %>
+
+%label.sublabels.each do |sublabel|
+  * <%= sublabel %>
+%end
+
+%label.releases.each do |release|
+  * [<%= release.catno %>] <%= release.artist %> - <%= release.title %>
+%end
+
+TEMPLATE
+
+require 'erb'
+
+label = Discogs::Label.parse(data,:releases)
+$stdout << ERB.new(template, nil, "%").result(binding)
+
+label = Discogs::Label.parse(data)
+$stdout << ERB.new(template, nil, "%").result(binding)
+
+# EOF

data/examples/discogs/search.rb

@@ -0,0 +1,60 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'helper'))
+
+require 'zlib'
+
+module Discogs
+
+  def self.search(t,q)
+    Discogs::Search.get("search",
+      :query => {"type" => t, "q" => q},
+      :headers => {"Accept-Encoding" => "gzip,*;q=0"}) do |response|
+      Zlib::GzipReader.new(StringIO.new(response.body)).read
+    end
+  end
+
+  class Search
+
+    include SMG::Resource
+    include SMG::HTTP
+
+    class ExactResult
+      include SMG::Resource
+      extract 'result', :at => 'type', :as => :resource_type
+      extract 'result/title'
+      extract 'result/uri'
+    end
+
+    class Result
+      include SMG::Resource
+      extract 'result', :at => 'type', :as => :resource_type
+      extract 'result/title'
+      extract 'result/uri'
+      extract 'result/summary'
+    end
+
+    site "http://www.discogs.com"
+    params "f" => "xml", "api_key" => "API_KEY"
+
+    root 'resp'
+    collect 'exactresults/result', :as => :exactresults, :class => ExactResult
+    collect 'searchresults/result', :as => :results, :class => Result
+
+  end
+
+end
+
+search = Discogs.search("all", "Genosha Recordings")
+
+puts <<-RESULT
+    type: #{search.exactresults.first.resource_type}
+   title: #{search.exactresults.first.title}
+     URI: #{search.exactresults.first.uri}
+   total: #{search.results.size}
+RESULT
+
+#    type: label
+#   title: Genosha Recordings
+#     URI: http://www.discogs.com/label/Genosha+Recordings
+#   total: 20
+
+# EOF

data/examples/plant.rb

@@ -20,7 +20,7 @@ class Plant
   extract 'genus'             , :context => [:classification]
   extract 'binomial'
   extract 'conservation'      , :context => [:conservation, :info], :class => Conservation
-  collect 'synonims/binomial' , :context => [:synonims], :as => :synonims, 
+  collect 'synonims/binomial' , :context => [:synonims], :as => :synonims
 
 end
 
@@ -85,5 +85,4 @@ puts plant.conservation.code    #=> "NE"
 puts plant.conservation.status  #=> nil
 puts plant.synonims             #=> []
 
-
 # EOF

data/examples/twitter.rb

@@ -5,8 +5,8 @@ class Status
 
   root 'status'
 
-  extract :id         , :class => :integer, :as => :status_id
-  extract :created_at , :class => :datetime
+  extract :id                 , :class => :integer, :as => :status_id
+  extract :created_at         , :class => :datetime
   extract :text
 
 end
@@ -28,8 +28,11 @@ end
 data = File.read(ROOT.join('spec/fixtures/twitter/pipopolam.xml'))
 user = User.parse(data)
 
-puts "#{user.screen_name} (#{user.name}), since #{user.created_at.strftime('%Y.%m.%d')}"
-puts user.location
-puts user.status.text
+puts <<-EOS
+      ID: #{user.twitter_id}
+          #{user.screen_name} (#{user.name}), since #{user.created_at.strftime('%Y.%m.%d')}
+location: #{user.location}
+  status: #{user.status.text}
+EOS
 
 # EOF

data/examples/weather.rb

@@ -0,0 +1,146 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'helper'))
+
+class YWeather
+
+  CONDITION_CODES = {
+     1 => "tornado",
+     2 => "tropical storm",
+     3 => "hurricane",
+     4 => "severe thunderstorms",
+     4 => "thunderstorms",
+     5 => "mixed rain and snow",
+     6 => "mixed rain and sleet",
+     7 => "mixed snow and sleet",
+     8 => "freezing drizzle",
+     9 => "drizzle",
+    10 => "freezing rain",
+    11 => "showers",
+    12 => "showers",
+    13 => "snow flurries",
+    14 => "light snow showers",
+    15 => "blowing snow",
+    16 => "snow",
+    17 => "hail",
+    18 => "sleet",
+    19 => "dust",
+    20 => "foggy",
+    21 => "haze",
+    22 => "smoky",
+    23 => "blustery",
+    24 => "windy",
+    25 => "cold",
+    26 => "cloudy",
+    27 => "mostly cloudy (night)",
+    28 => "mostly cloudy (day)",
+    29 => "partly cloudy (night)",
+    30 => "partly cloudy (day)",
+    31 => "clear (night)",
+    32 => "sunny",
+    33 => "fair (night)",
+    34 => "fair (day)",
+    35 => "mixed rain and hail",
+    36 => "hot",
+    37 => "isolated thunderstorms",
+    38 => "scattered thunderstorms",
+    39 => "scattered thunderstorms",
+    40 => "scattered showers",
+    41 => "heavy snow",
+    42 => "scattered snow showers",
+    43 => "heavy snow",
+    44 => "partly cloudy",
+    45 => "thundershowers",
+    46 => "snow showers",
+    47 => "isolated thundershowers",
+    3200 => "not available"
+    }
+
+  class Forecast
+    include SMG::Resource
+
+    extract "yweather:forecast"   , :at => :low
+    extract "yweather:forecast"   , :at => :high
+    extract "yweather:forecast"   , :at => :day
+    extract "yweather:forecast"   , :at => :date  , :class => :datetime
+    extract "yweather:forecast"   , :at => :code  , :class => :integer
+    extract "yweather:forecast"   , :at => :text
+
+    def condition
+      CONDITION_CODES[code]
+    end
+
+  end
+
+  class Condition
+    include SMG::Resource
+
+    extract "yweather:condition"  , :at => :temp
+    extract "yweather:condition"  , :at => :date
+    extract "yweather:condition"  , :at => :text
+    extract "yweather:condition"  , :at => :code  , :class => :integer
+
+    def condition
+      CONDITION_CODES[code]
+    end
+
+  end
+
+  class Units
+    include SMG::Resource
+
+    extract "yweather:units"      , :at => :temperature
+    extract "yweather:units"      , :at => :distance
+    extract "yweather:units"      , :at => :pressure
+    extract "yweather:units"      , :at => :speed
+  end
+
+  class Atmosphere
+    include SMG::Resource
+
+    extract "yweather:atmosphere" , :at => :humidity
+    extract "yweather:atmosphere" , :at => :visibility
+    extract "yweather:atmosphere" , :at => :pressure
+    extract "yweather:atmosphere" , :at => :rising
+  end
+
+  class Location
+    include SMG::Resource
+
+    extract "yweather:location"   , :at => :city
+    extract "yweather:location"   , :at => :region
+    extract "yweather:location"   , :at => :country
+  end
+
+  class Wind
+    include SMG::Resource
+
+    extract "yweather:wind"       , :at => :chill
+    extract "yweather:wind"       , :at => :direction
+    extract "yweather:wind"       , :at => :speed
+  end
+
+  include SMG::Resource
+
+  root 'rss/channel'
+
+  extract "lastBuildDate"         , :as => :built_at
+  extract "yweather:astronomy"    , :at => :sunrise
+  extract "yweather:astronomy"    , :at => :sunset
+  extract "yweather:location"     , :as => :wind        , :class => Location
+  extract "yweather:units"        , :as => :units       , :class => Units
+  extract "yweather:atmosphere"   , :as => :atmosphere  , :class => Atmosphere
+  extract "yweather:wind"         , :as => :wind        , :class => Wind
+
+  root 'rss/channel/item'
+
+  extract "geo:lat"               , :as => :latitude
+  extract "geo:long"              , :as => :longitude
+  extract "title"                 , :as => :title
+  extract "yweather:condition"    , :as => :current     , :class => Condition
+  collect "yweather:forecast"     , :as => :forecasts   , :class => Forecast
+
+end
+
+data = File.read(ROOT.join('spec/fixtures/yahoo.weather.com.xml'))
+yweather = YWeather.parse(data)
+
+# EOF

data/lib/smg.rb

@@ -11,4 +11,8 @@ require 'smg/model'
 require 'smg/resource'
 require 'smg/document'
 
+module SMG
+  autoload :HTTP, 'smg/http'
+end
+
 # EOF

data/lib/smg/document.rb

@@ -11,27 +11,42 @@ module SMG #:nodoc:
       @thing    = thing
       @context  = context
       @chars    = ""
+
+      @mapping.refresh!
     end
 
-    def start_element(name, attrs = [])
+    def start_element(name, attrs)
 
       @stack << name
+      ahash = nil
 
       if doc = @docs.last
         doc.start_element(name, attrs)
-      elsif (thing = @mapping.nested[@stack]) && thing.in_context_of?(@context)
+      elsif (thing = @mapping.nested[@stack]) &&
+          !@mapping.parsed.include?(thing.object_id) &&
+          thing.in_context_of?(@context) &&
+          thing.with?(ahash ||= Hash[*attrs])
+
         @docs << doc = Document.new(thing.data_class.new,@context,thing)
         doc.start_element(name, attrs)
       end
 
       if !attrs.empty? && maps = @mapping.attributes[@stack]
-        attrh = Hash[*attrs]
-        maps.values_at(*attrh.keys).compact.each do |m|
-          @object.__send__(m.accessor, m.cast(attrh[m.at])) if m.in_context_of?(@context)
+        maps.values_at(*(ahash ||= Hash[*attrs]).keys).compact.each do |m|
+          if !@mapping.parsed.include?(m.object_id) &&
+            m.in_context_of?(@context) &&
+            m.with?(ahash)
+
+            @object.__send__(m.accessor, m.cast(ahash[m.at]))
+            @mapping.parsed << m.object_id unless m.collection?
+          end
         end
       end
 
-      if (e = @mapping.elements[@stack]) && e.in_context_of?(@context)
+      if (e = @mapping.elements[@stack]) &&
+          !@mapping.parsed.include?(e.object_id) &&
+          e.in_context_of?(@context) &&
+          e.with?(ahash ||= Hash[*attrs])
         @element = e
         @chars = ""
       end
@@ -42,15 +57,17 @@ module SMG #:nodoc:
 
       if @element
         @object.__send__(@element.accessor, @element.cast(@chars))
+        @mapping.parsed << @element.object_id unless @element.collection?
         @chars = ""
         @element = nil
       end
 
       if doc = @docs.last
         doc.end_element(name)
-        if doc.thing.path == @stack
-          @object.__send__(doc.thing.accessor, doc.object)
+        if (t = doc.thing).path == @stack
+          @object.__send__(t.accessor, doc.object)
           @docs.pop
+          @mapping.parsed << t.object_id unless t.collection?
         end
       end