ardekantur-wondercroc 0.0.3

data/lib/client.rb

@@ -0,0 +1,92 @@
+require 'rubygems'
+require 'rest_client'
+require 'rexml/document'
+require 'rss/2.0'
+
+# NewsGator is a Ruby layer for interacting with the
+# NewsGator API.
+     
+module WonderCroc
+class NewsGatorClient
+  
+  VERSION = [ 0, 0, 3 ].join '.'
+  SERVICE = "http://services.newsgator.com/ngws/svc"
+  
+  BULLETIN_TOKEN = { 
+    "X-NGAPITOKEN"    => "A8BBE03745F2439287D9425AB4BFFC30",
+    "User-Agent"      => "bulletin/#{VERSION}",
+    "Accept-Encoding" => "compress,gzip"
+     }
+     
+     attr_accessor :response
+     attr_accessor :folders
+
+     # Initializes an instance of a NewsGator connection
+     # with the provided +Configuration+ object.
+     def initialize config_obj
+       @config = config_obj
+       @folder_unread_counts = {}
+       self.clear_locations
+     end
+    
+    def get_feed id, unread = true
+      new_connection_to "/Feed.aspx/#{id}?unread=#{unread.to_s.capitalize}"
+      send_request :get
+    end
+    
+    def get_random_feed
+      raise "no feeds" unless @subscriptions
+      get_feed @subscriptions[(rand * @subscriptions.length).floor].id, false
+    end
+
+    def parse_stories 
+      p = RSS::Parser.new @response
+      p.do_validate = false
+      p.parse
+    end
+
+    def get_unread_counts ui = nil
+      ui.update_status 'Getting subscription counts...' if ui
+      new_connection_to "/Subscription.aspx/#{@location[:id]}/subscriptionCounts"
+      send_request :get
+      doc = REXML::Document.new @response
+    REXML::XPath.each(doc, "descendant-or-self::*") do |e|
+      @folder_unread_counts[e.attributes['ng:folderId']] = @folder_unread_counts.fetch(e.attributes['ng:folderId'], 0) + e.attributes['ng:unreadCount'].to_i
+    end
+    @folders.flatten.each { |f| f.unread_count = @folder_unread_counts.fetch(f.id, 0) }
+    ui.update_status ''
+  end
+  
+  private
+
+  def new_connection_to url
+    @request = RestClient::Resource.new(SERVICE + url, @config.user, @config.password)
+  end
+
+  def send_request type, headers = {}
+    raise ArgumentError, "invalid send request type #{type}" unless [ :get, :delete ].include? type
+    @response = @request.send type, BULLETIN_TOKEN.merge(headers)
+  end
+
+  def send_data type, payload, headers = {}
+    raise ArgumentError, "invalid send data request type #{type}" unless [ :put, :post ].include? type
+    @response = @request.send type, payload, BULLETIN_TOKEN.merge(headers)
+  end
+  
+end
+end
+
+class RSS::Rss::Channel::Item
+   [
+     ["read",      :boolean ],
+     ["id",        :integer ],
+     ["postId",    :integer ],
+     ["avgRating", :float   ],
+     ["clipped",   :boolean ],
+     ["token",     :text    ],
+     ["folderId",  :text    ]
+   ].each do |elem, type|
+     install_text_element "ng:#{elem}", "http://newsgator.com/schema/extensions", '?', "#{elem}", type, "ng:#{elem}"
+     RSS::BaseListener.install_get_text_element "http://newsgator.com/schema/extensions", "#{elem}", "#{elem}="
+   end
+end

data/lib/folder.rb

@@ -0,0 +1,57 @@
+# A folder is a folder that resides in a NewsGator location.
+# It can contain subscriptions and other folders.
+
+module WonderCroc
+class Folder
+
+  attr_accessor :id, :name, :unread_count
+
+  def initialize name, id
+    @name = name
+    @id = id
+    @unread_count = 0
+  end
+
+  def to_str
+    return @name if @unread_count == 0
+    return "#{@name} (#{@unread_count})"
+  end
+  
+end
+
+class NewsGatorClient
+
+  def folders_from_xml xml
+    folders = []
+    doc = REXML::Document.new xml
+    doc.elements.each('opml/body/outline') do |e|
+      dir = [ Folder.new(e.attributes['title'], e.attributes['ng:id']) ]
+      dir << subfolders(e)
+      folders << dir.compact
+    end
+    return folders.compact
+  end
+
+  def subfolders element
+    return nil if element.elements.size == 0
+    folders = []
+    element.each do |e|
+      folders << Folder.new(e.attributes['title'], e.attributes['ng:id'])
+      folders << subfolders(e)
+    end
+
+    return folders.compact
+  end
+  
+  private
+  
+  # Return a list of all folders in the user's subscription.
+  def get_folders
+    new_connection_to "/Folder.aspx"
+    send_request :get
+    @folders = folders_from_xml(@response)
+  end
+
+end
+
+end

data/lib/location.rb

@@ -0,0 +1,72 @@
+module WonderCroc
+class NewsGatorClient
+  
+  # Emptys the location cache.
+  def clear_locations
+    @locations = []
+  end
+
+  def set_location_from_config
+    get_locations
+    @location = @locations.find { |l| l[:title] == @config.location }
+    raise "no location found for name #{@config.location}" unless @location
+  end
+
+  # Retrieves a list of all of the user's locations.
+  def get_locations
+    clear_locations
+    new_connection_to '/Location.aspx'
+    send_request :get 
+    @locations = locations_from_xml(@response)
+  end
+  
+  def location_info id
+    return @locations.find { |l| l[:id] == id }
+    return nil
+  end
+  
+  def delete_location id
+    new_connection_to "/Location.aspx/#{id}"
+    send_request :delete
+  end
+  
+  def get_subscriptions_from_location id = @location[:id]
+    new_connection_to "/Subscription.aspx/#{id}"
+    send_request :get
+    @subscriptions = subscriptions_from_xml(@response)
+  end
+
+  def add_location name, add_subscriptions = true
+    new_connection_to "/Location.aspx"
+    payload = <<-OPML
+    <opml xmlns:ng="http://newsgator.com/schema/opml">
+      <head />
+      <body>
+        <outline text="#{name}" ng:autoAddSubs="#{add_subscriptions.to_s.capitalize}" />
+      </body>
+    </opml>
+    OPML
+    send_data :post, payload, :content_type => 'application/xml'
+    puts @response
+  end
+  
+  private
+  
+  def locations_from_xml xml
+    locations = []
+    doc = REXML::Document.new xml
+    doc.elements.each('opml/body/outline') do |e|
+      l = {
+        :id                     => e.attributes['ng:id'].to_i,
+        :title                  => e.attributes['text'],
+        :url                    => e.attributes['url'],
+        :auto_add_subscriptions => e.attributes['ng:autoAddSubs'] == "True" ? true : false,
+        :is_public              => e.attributes['ng:isPublic'] == "True" ? true : false
+      }
+      locations << l
+    end
+    return locations
+  end
+  
+end
+end

data/lib/subscription.rb

@@ -0,0 +1,36 @@
+module WonderCroc
+
+# A subscription is a single RSS feed that is subscribed to by
+# NewsGator.
+class Subscription
+  attr_accessor :title, :title, :id, :xml_url, :html_url, :sync_xml_url
+  attr_accessor :folder_id, :description, :subscriber_count, :unseen
+  attr_accessor :unread, :updated, :use_default_credentials
+end
+
+class NewsGatorClient
+  
+  private
+  
+  def subscriptions_from_xml xml
+    subscriptions = []
+    doc = REXML::Document.new xml
+    doc.elements.each('opml/body/outline') do |e|
+      s = Subscription.new
+      s.title             = e.attributes['title']
+      s.id                = e.attributes['ng:id'].to_i
+      s.xml_url           = e.attributes['xmlUrl']
+      s.html_url          = e.attributes['htmlUrl']
+      s.sync_xml_url      = e.attributes['ng:syncXmlUrl']
+      s.subscriber_count  = e.attributes['ng:subscriberCount'].to_i
+      s.unseen            = e.attributes['ng:unseen'] == "True" ? true : false
+      s.unread            = e.attributes['ng:unread'] == "True" ? true : false
+      s.updated           = e.attributes['ng:updated'] == "True" ? true : false
+      s.folder_id         = e.attributes['ng:folderId']
+      subscriptions << s
+    end
+    return subscriptions
+  end
+  
+end
+end

data/spec/folder_spec.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + '/../lib/folder'
+
+describe WonderCroc::Folder do
+  
+  it "should require a name"
+  
+end

data/wondercroc.gemspec

@@ -0,0 +1,21 @@
+Gem::Specification.new do |s|
+  s.name = "wondercroc"
+  s.version = "0.0.3"
+  s.date = "2008-06-24"
+  s.summary = "a ruby api for interacting with the newsgator feed synchronization service."
+  s.email = "greystone@ardekantur.com"
+  s.homepage = "http://github.com/ardekantur/wondercroc"
+  s.description = ""
+  s.has_rdoc = false
+  s.authors = ["Ardekantur"]
+  s.require_path = "lib"
+  s.files = [ "wondercroc.gemspec", "README", "lib/client.rb", "lib/folder.rb", "lib/location.rb", "lib/subscription.rb"]
+  s.test_files = ["spec/folder_spec.rb"]
+  s.add_dependency('rest_client')
+=begin
+  s.test_files = ["test/test_actor.rb", "test/test_blob.rb", "test/test_commit.rb", "test/test_config.rb", "test/test_diff.rb", "test/test_git.rb", "test/test_head.rb", "test/test_real.rb", "test/test_reality.rb", "test/test_repo.rb", "test/test_tag.rb", "test/test_tree.rb"]
+  s.rdoc_options = ["--main", "README.txt"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.txt"]
+  s.add_dependency("mime-types", ["> 0.0.0"])
+=end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: ardekantur-wondercroc
+version: !ruby/object:Gem::Version 
+  version: 0.0.3
+platform: ruby
+authors: 
+- Ardekantur
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-06-24 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rest_client
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: ""
+email: greystone@ardekantur.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- wondercroc.gemspec
+- README
+- lib/client.rb
+- lib/folder.rb
+- lib/location.rb
+- lib/subscription.rb
+has_rdoc: false
+homepage: http://github.com/ardekantur/wondercroc
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: a ruby api for interacting with the newsgator feed synchronization service.
+test_files: 
+- spec/folder_spec.rb