ardekantur-wondercroc 0.0.4 → 0.0.5

data/README.rdoc

@@ -1,3 +1,33 @@
 = wondercroc
 
-A gem that provides...
+A gem that provides functionality for interfacing with the NewsGator online feed reading service.
+
+= simple to use
+
+ c = WonderCroc::Client.new :user => 'newsgator_user', :password => 'newsgator_pass', :location => 'newsgator_location'
+
+Or, if you have a YAML file like this:
+
+ user: newsgator_user
+ password: newsgator_password
+ location: newsgator_location
+
+You can pass it in like this:
+
+ c = WonderCroc::Client.new :file => '/path/to/config.yml'
+
+If you don't specify a location anywhere, it will default to the name of the library, a hyphen, and the name of your machine (in all caps), like thus:
+
+ wondercroc-MY_IMAC
+
+= folders
+
+Folders are a tree of the folders you have at the location you specified previously.
+
+ c.get_folders
+
+= subscriptions
+
+ c.get_subscriptions_from_location
+
+That's kind of where I am right now, poke around in irb to get a better feel for what you can do from there.

data/Rakefile

@@ -8,7 +8,7 @@ require 'spec/rake/verify_rcov'
 
 
 GEM = "wondercroc"
-GEM_VERSION = "0.0.4"
+GEM_VERSION = "0.0.5"
 AUTHOR = "Ardekantur"
 EMAIL = "greystone@ardekantur.com"
 HOMEPAGE = "http://github.com/ardekantur/wondercroc"
@@ -59,10 +59,15 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'doc' # rdoc output folder
 end
 
-desc "Run RSpec and Rcov"
+desc "run specs"
+Spec::Rake::SpecTask.new("spec") do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+desc "run rspec + rcov"
 Spec::Rake::SpecTask.new("spec:rcov") do |t|
   t.spec_files = FileList['spec/**/*_spec.rb']
-  t.rcov_opts = ['--exclude', "spec/,rcov.rb,rspec.rb,spec*"]
+  t.rcov_opts = ['--exclude', "spec/,rcov.rb,rspec.rb,spec*,gems*"]
   t.rcov = true
   t.rcov_dir = 'doc/coverage'
 end

data/lib/wondercroc.rb

@@ -1 +1,6 @@
-%w{ client folder location subscription }.each { |x| require "wondercroc/#{x}" }
+
+# WonderCroc is a library for retrieving subscriptions from a NewsGator online RSS feed reading account.
+# Please see the README for more information.
+module WonderCroc; end;
+
+%w{ config client folder location subscription }.each { |x| require "wondercroc/#{x}" }

data/lib/wondercroc/client.rb

@@ -2,20 +2,18 @@ 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
 
+  VERSION = [ 0, 0, 5 ].join '.'
+
   class Client
   
-    VERSION = [ 0, 0, 4 ].join '.'
     SERVICE = "http://services.newsgator.com/ngws/svc"
   
     BULLETIN_TOKEN = { 
       "X-NGAPITOKEN"    => "A8BBE03745F2439287D9425AB4BFFC30",
-      "User-Agent"      => "wondercroc/#{VERSION}",
+      "User-Agent"      => "wondercroc/#{WonderCroc::VERSION}",
       "Accept-Encoding" => "compress,gzip"
        }
      
@@ -23,13 +21,22 @@ module WonderCroc
        attr_accessor :folders
 
        # Initializes an instance of a NewsGator Client.
-       # +config_obj+ is a hash consisting of the keys
-       # +:name+, +:password+, and +:location+, if you do
-       # not want WonderCroc auto-generating a location name.
-       def initialize config_obj
-         @config = config_obj
+       # +config_options+ is a hash consisting of either all the informatio
+       # required to start a NewsGator connection (:user, :password, and :location),
+       # or the name of a file that has all those values in a YAML file (:file).
+       #
+       # We then set the location from the configuration hash passed through
+       # at the instantsiation of the Client object. If a +:location+
+       # key was not passed with that has, the location name is generated
+       # like so: 'newsgator_account_name-MACHINE_HOSTNAME'.
+       def initialize config_options
+         @config = WonderCroc::Configuration.new config_options
          @folder_unread_counts = {}
-         self.clear_locations
+
+         get_locations
+         @location = @locations.find { |l| l[:title] == @config.location }
+         raise "no location found for name #{@config.location}" unless @location
+
        end
     
       def get_feed id, unread = true
@@ -37,19 +44,13 @@ module WonderCroc
         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
+      def get_unread_counts
         new_connection_to "/Subscription.aspx/#{@location[:id]}/subscriptionCounts"
         send_request :get
         doc = REXML::Document.new @response
@@ -57,26 +58,46 @@ module WonderCroc
         @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])
+      @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)
+
+      begin
+        @response = @request.send type, BULLETIN_TOKEN.merge(headers)
+      rescue RestClient::Unauthorized
+        raise IncorrectLoginError, "#{@config.user} was not able to login"
+      end
+
+      log_request_and_response
     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)
+
+      log_request_and_response
+    end
+    
+    def log_request_and_response
+      File.open(File.join(ENV['HOME'], 'wondercroc_logs'), 'a') do |f|
+        f.write "REQUEST TO: #{@request.inspect}\n"
+        f.write "RESPONSE:   #{@response}"
+        f.write "\n\n\n"
+      end       
     end
   
   end
+
+  class IncorrectLoginError < RuntimeError
+  end
+
 end
 
 class RSS::Rss::Channel::Item
@@ -86,8 +107,7 @@ class RSS::Rss::Channel::Item
      ["postId",    :integer ],
      ["avgRating", :float   ],
      ["clipped",   :boolean ],
-     ["token",     :text    ],
-     ["folderId",  :text    ]
+     ["token",     :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}="

data/lib/wondercroc/folder.rb

@@ -1,15 +1,28 @@
-# A folder is a folder that resides in a NewsGator location.
-# It can contain subscriptions and other folders.
 
 module WonderCroc
+
+class Client
+  
+  def find_folder_by_id folder_id
+    @subfolders.each { |subfolder| return subfolder if subfolder and subfolder.find_by_id folder_id}
+    return nil
+  end
+  
+end
+
+# A folder is a folder that resides in a NewsGator location.
+# It can contain subscriptions and other folders.
 class Folder
 
-  attr_accessor :id, :name, :unread_count
+  attr_accessor :folder_id, :name
+  attr_reader :unread_count
 
   def initialize name, id
+    raise ArgumentException unless name
     @name = name
-    @id = id
+    @folder_id = id
     @unread_count = 0
+    @subfolders = []
   end
 
   def to_str
@@ -17,6 +30,23 @@ class Folder
     return "#{@name} (#{@unread_count})"
   end
   
+  def subfolders
+    return @subfolders
+  end
+  
+  def << subfolder
+    @subfolders << subfolder
+  end
+  
+  def merge array
+    @subfolders += array if array
+  end
+  
+  def find_by_id id
+    return self if @folder_id == id
+    @subfolders.each { |subfolder| return subfolder if subfolder.find_by_id id}
+  end
+  
 end
 
 class Client
@@ -25,28 +55,29 @@ class Client
   def get_folders
     new_connection_to "/Folder.aspx"
     send_request :get
-    @folders = folders_from_xml(@response)
+    @folders = folders_from_xml(@response).subfolders
   end
   
   private
 
   def folders_from_xml xml
-    folders = []
+    root_folder = Folder.new 'Root', -1
     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
+      dir = Folder.new e.attributes['title'], e.attributes['ng:id']
+      dir.merge subfolders(e)
+      root_folder << dir
     end
-    return folders.compact
+    return root_folder
   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)
+      folder = Folder.new(e.attributes['title'], e.attributes['ng:id'])
+      folder.merge subfolders(e)
+      folders << folder
     end
 
     return folders.compact

data/lib/wondercroc/location.rb

@@ -7,17 +7,6 @@ class Client
     @locations = []
   end
 
-  # Sets the location from the configuration hash passed through
-  # at the instantsiation of the Client object. If a +:location+
-  # key was not passed with that has, the location name is generated
-  # like so: 'newsgator_account_name-MACHINE_HOSTNAME'.
-  def set_location_from_config
-    get_locations
-    @config[:location] ||= "#{@config[:user]}-#{`hostname`.strip.upcase}"
-    @location = @locations.find { |l| l[:title] == @config[:location] }
-    raise "no location found for name #{@config.location}" unless @location
-  end
-
   # Retrieves a list of all the locations that the logged in user
   # has available.
   def get_locations

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ardekantur-wondercroc
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - Ardekantur
@@ -9,7 +9,7 @@ autorequire: wondercroc
 bindir: bin
 cert_chain: []
 
-date: 2008-07-01 00:00:00 -07:00
+date: 2008-07-06 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -30,6 +30,7 @@ files:
 - TODO
 - lib/wondercroc
 - lib/wondercroc/client.rb
+- lib/wondercroc/config.rb
 - lib/wondercroc/folder.rb
 - lib/wondercroc/location.rb
 - lib/wondercroc/subscription.rb