ardekantur-wondercroc 0.0.3 → 0.0.4

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 YOUR NAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,3 @@
+= wondercroc
+
+A gem that provides...

data/Rakefile

@@ -0,0 +1,68 @@
+require 'rubygems'
+require 'hanna/rdoctask'
+require 'rake/gempackagetask'
+require 'rubygems/specification'
+require 'date'
+require 'spec/rake/spectask'
+require 'spec/rake/verify_rcov'
+
+
+GEM = "wondercroc"
+GEM_VERSION = "0.0.4"
+AUTHOR = "Ardekantur"
+EMAIL = "greystone@ardekantur.com"
+HOMEPAGE = "http://github.com/ardekantur/wondercroc"
+SUMMARY = "a ruby api for interacting with the newsgator feed synchronization service"
+
+spec = Gem::Specification.new do |s|
+  s.name = GEM
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README.rdoc", "LICENSE", 'TODO']
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  
+  # Uncomment this to add a dependency
+  # s.add_dependency "foo"
+  
+  s.require_path = 'lib'
+  s.autorequire = GEM
+  s.files = %w(LICENSE README.rdoc Rakefile TODO) + Dir.glob("{lib,specs}/**/*")
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "install the gem locally"
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{GEM}-#{GEM_VERSION}}
+end
+
+desc "create a gemspec file"
+task :make_spec do
+  File.open("#{GEM}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end
+
+desc "generate rdoc documentation"
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_files.include('README.rdoc', 'LICENSE', 'TODO').
+    include('lib/**/*.rb')
+
+  rdoc.main = "README.rdoc"
+  rdoc.rdoc_dir = 'doc' # rdoc output folder
+end
+
+desc "Run RSpec and 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 = true
+  t.rcov_dir = 'doc/coverage'
+end

data/TODO

@@ -0,0 +1,4 @@
+TODO:
+Fix LICENSE with your name
+Fix Rakefile with your name and contact info
+Add your code to lib/<%= name %>.rb

data/lib/wondercroc.rb

@@ -0,0 +1 @@
+%w{ client folder location subscription }.each { |x| require "wondercroc/#{x}" }

data/lib/wondercroc/client.rb

@@ -0,0 +1,95 @@
+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 Client
+  
+    VERSION = [ 0, 0, 4 ].join '.'
+    SERVICE = "http://services.newsgator.com/ngws/svc"
+  
+    BULLETIN_TOKEN = { 
+      "X-NGAPITOKEN"    => "A8BBE03745F2439287D9425AB4BFFC30",
+      "User-Agent"      => "wondercroc/#{VERSION}",
+      "Accept-Encoding" => "compress,gzip"
+       }
+     
+       attr_accessor :response
+       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
+         @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 → wondercroc/folder.rb}

@@ -19,7 +19,16 @@ class Folder
   
 end
 
-class NewsGatorClient
+class Client
+
+  # 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
+  
+  private
 
   def folders_from_xml xml
     folders = []
@@ -42,15 +51,6 @@ class NewsGatorClient
 
     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
 

data/lib/{location.rb → wondercroc/location.rb}

@@ -1,18 +1,25 @@
 module WonderCroc
-class NewsGatorClient
+  
+class Client
   
   # Emptys the location cache.
   def clear_locations
     @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
-    @location = @locations.find { |l| l[:title] == @config.location }
+    @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 of the user's locations.
+  # Retrieves a list of all the locations that the logged in user
+  # has available.
   def get_locations
     clear_locations
     new_connection_to '/Location.aspx'
@@ -25,6 +32,9 @@ class NewsGatorClient
     return nil
   end
   
+  # Deletes a location from the online service.
+  # This does not require any kind of confirmation, and
+  # is permanent for all intents and purposes.
   def delete_location id
     new_connection_to "/Location.aspx/#{id}"
     send_request :delete
@@ -36,6 +46,11 @@ class NewsGatorClient
     @subscriptions = subscriptions_from_xml(@response)
   end
 
+  # Adds a location to the online service.
+  # +name+ is the name of the location, +add_subscriptions+
+  # is a boolean option corresponding to whether or not
+  # subscriptions are automatically added to this location
+  # whenever the user subscribes to a new feed.
   def add_location name, add_subscriptions = true
     new_connection_to "/Location.aspx"
     payload = <<-OPML

data/lib/{subscription.rb → wondercroc/subscription.rb}

@@ -8,7 +8,7 @@ class Subscription
   attr_accessor :unread, :updated, :use_default_credentials
 end
 
-class NewsGatorClient
+class Client
   
   private
   

metadata

@@ -1,42 +1,40 @@
 --- !ruby/object:Gem::Specification 
 name: ardekantur-wondercroc
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Ardekantur
-autorequire: 
+autorequire: wondercroc
 bindir: bin
 cert_chain: []
 
-date: 2008-06-24 00:00:00 -07:00
+date: 2008-07-01 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: ""
+dependencies: []
+
+description: a ruby api for interacting with the newsgator feed synchronization service
 email: greystone@ardekantur.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+- TODO
 files: 
-- wondercroc.gemspec
-- README
-- lib/client.rb
-- lib/folder.rb
-- lib/location.rb
-- lib/subscription.rb
-has_rdoc: false
+- LICENSE
+- README.rdoc
+- Rakefile
+- TODO
+- lib/wondercroc
+- lib/wondercroc/client.rb
+- lib/wondercroc/folder.rb
+- lib/wondercroc/location.rb
+- lib/wondercroc/subscription.rb
+- lib/wondercroc.rb
+has_rdoc: true
 homepage: http://github.com/ardekantur/wondercroc
 post_install_message: 
 rdoc_options: []
@@ -58,9 +56,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.0.1
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: a ruby api for interacting with the newsgator feed synchronization service.
-test_files: 
-- spec/folder_spec.rb
+summary: a ruby api for interacting with the newsgator feed synchronization service
+test_files: []
+

data/lib/client.rb

@@ -1,92 +0,0 @@
-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/spec/folder_spec.rb

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

data/wondercroc.gemspec

@@ -1,21 +0,0 @@
-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