r43 0.2.0 → 0.3.0

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.10
 specification_version: 1
 name: r43
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
-date: 2005-07-29
+  version: 0.3.0
+date: 2005-08-03
 summary: A Ruby wrapper for the 43 Things web services API
 require_paths: 
   - lib
@@ -28,46 +28,58 @@ authors:
   - Pat Eyler
 files: 
   - test/get_goal_by_name-255.xml
+  - test/get_tags_goals-travel.xml
+  - test/idea-get_person-pate.xml
   - test/get_goals_entries-255-offset20.xml
+  - test/search_tags-travel.xml
   - test/get_persons_teammates-erik.xml
+  - test/get_tags_goals-travel-offset80-max10.xml
   - test/search_goals-ruby.xml
-  - test/test_r43.rb.~1.8.~
   - test/get_persons_neighbors-erik.xml
   - test/get_persons_progress_on_goal-erik-9.xml
+  - test/search_tags-lose+weight.xml
   - test/search_goals-ruby-offset20-max10.xml
   - test/get_goals_people-533-offset20.xml
   - test/search_goals-schemer.xml
   - test/get_persons_tags-erik.xml
   - test/search_cities-london.xml
   - test/get_city-36.xml
+  - test/get_city-1164.xml
   - test/get_goals_entries-533.xml
   - test/search_people-Sean.xml
   - test/get_person-erik.xml
   - test/get_goals_people-533.xml
   - test/get_citys_people-1164.xml
+  - test/get_teams_progress-222591.xml
   - test/get_persons_entries-erik.xml
+  - test/es-get_persons_tags-Alvaro.xml
   - test/get_persons_tag_cloud-erik.xml
   - test/test_r43.rb
   - test/get_goal_by_id-255.xml
   - test/get_persons_completed_things-erik.xml
+  - test/search_tags-travel-offset20.xml
   - test/get_persons_neighbors-erik-20.xml
   - test/get_citys_people-1164-offset20.xml
   - test/authentication.xml
   - test/search_people_by_email-erik@mockerybird.com.xml
   - test/search_goals-ruby-offset20.xml
+  - test/get_tags_goals-travel-offset20.xml
   - test/echo.xml
+  - test/get_tags_similarities-travel.xml
   - test/get_person-sweeting.xml
   - test/get_entry-33.xml
+  - test/get_teams_progress-7.xml
   - test/get_person-flickr_username.xml
+  - test/get_goal_by_id-533.xml
   - test/get_goals_similarities-255.xml
-  - lib/id.rb
-  - lib/person.rb
+  - lib/r43
   - lib/r43.rb
-  - lib/goal.rb
-  - lib/entry.rb
-  - lib/tag.rb
-  - lib/r43.rb.~1.6.~
-  - lib/city.rb
+  - lib/r43/id.rb
+  - lib/r43/person.rb
+  - lib/r43/goal.rb
+  - lib/r43/entry.rb
+  - lib/r43/tag.rb
+  - lib/r43/city.rb
 test_files: []
 rdoc_options: []
 extra_rdoc_files: []

data/lib/r43.rb.~1.6.~

@@ -1,645 +0,0 @@
-# copyright 2005 Pat Eyler, Sean Carley, & Edward Cho
-# distributed under the same terms as Ruby
-
-
-require 'net/http'
-require 'rexml/document'
-
-
-#
-# Implements a city object from 43 things.  Currently only meant
-# to be contructed by an R43::Request object.
-#
-
-class City
-  attr_accessor :city_id, :name, :region, :country, :num_people,
-                :link, :goals   
-
-  def initialize()
-    # just to initialize the object, we'll always feed the attributes
-    # in some other way
-  end
-
-
-  #
-  # Builds a City object from 43 things.  Currently only meant to 
-  # constructed by an R43::Request object.
-  #
-  def City.from_xml(xml)
-    city = City.new()
-    city.name= xml.elements["name"].text
-    city.region= xml.elements["region"].text
-    city.country= xml.elements["country"].text
-    city.num_people= xml.elements["num_people"].text.to_i
-    city.link=  xml.elements["link"].attributes["href"]
-    city.city_id= xml.attributes["city_id"].to_i
-    
-    city.goals = Array.new
-    xml.elements.each("goal") do |goal_element|
-      goal = Goal.from_xml(goal_element)
-      city.goals.push(goal)
-    end
-
-    city
-  end
-
-end
-
-
-#
-# Implements an entry object from 43 things.  Currently only meant
-# to be constructed by an R43::Request object.
-#
-#
-
-class Entry
-  attr_accessor :title, :author, :dc_subject, :goal, :content,
-               :num_comments, :issued, :link, :id
-
-  def initialize()
-    # just to initialize the object, we'll always feed the attributes
-    # in some other way
-  end
-
-
-  #
-  # Builds an Entry object from an xml object.  Normally, this is
-  # called by the get_entry method of an R43::Request object.
-  #
-  def Entry.from_xml(xml)
-    entry = Entry.new
-
-    if xml.elements["title"] then
-      entry.title= xml.elements["title"].text
-    end
-    entry.dc_subject= xml.elements["dc:subject"].text
-    entry.content= xml.elements["content"].text
-    entry.num_comments= 
-      xml.elements["num_comments"].text.to_i
-    entry.issued= xml.elements["issued"].text
-    entry.link= xml.elements["link"].attributes["href"]
-    entry.id= xml.elements["id"].text
-
-    xml.elements.each("author") do |entry_element|
-      entry.author= Person.from_xml(entry_element)
-    end
-
-    goal = Goal.new
-    xml.elements.each("goal") do |goal_entry|
-      goal = Goal.from_xml(goal_entry)
-    end
-    entry.goal= goal
-
-    entry
-  end
-
-end
-
-#
-# Implements a person object from 43 things.  Currently only meant to
-# be constructed by a R43::Request object:
-# 
-#   require 'r43'
-#   connect = R43::Request.new(<api_key>)
-#   person = connect.get_person('<username>')
-#
-class Person
-  attr_accessor :username, :name, :url, :profile_image_url, 
-              :num_open_goals, :link, :city, :goals, :flickr_username
-
-  def initialize()
-    # just to create the object, we'll always feed the attributes in
-    # some other way
-  end
-
-
-  #
-  # Builds a Person object from an xml object.  Normally, this is
-  # called by the get_person method of an R43::Request object.
-  #
-  def Person.from_xml(xml)
-    person = Person.new
-
-    person.username= xml.elements["username"].text
-    person.name= xml.elements["name"].text
-    person.url= xml.elements["url"].text
-    person.num_open_goals= 
-      xml.elements["num_open_goals"].text.to_i
-    person.link= xml.elements["link"].attributes["href"]
-
-    person.flickr_username=xml.elements["flickr_username"].text if xml.elements["flickr_username"]
-    
-    if xml.elements["profile_image_url"] then 
-      person.profile_image_url= 
-        xml.elements["profile_image_url"].text
-    else
-      person.profile_image_url= "none"
-    end
-
-    if xml.elements["city"] then
-      xml.elements.each("city") do |element|
-        person.city = City.from_xml(element)
-      end
-    end
-
-    person.goals = Array.new
-    xml.elements.each("open_goals/goal") do |goal_element| 
-      goal = Goal.from_xml(goal_element)
-      person.goals.push(goal)
-    end   
-    
-    person
-  end
-
-end
-
-#
-# Implements a goal object from 43 things.  Currently only meant to be
-# constructed by an R43::Request object
-#
-#  require 'r43'
-#  connect = R43::Request.new(<api_key>)
-#  goal = get_goal_by_id(<goal_id>)
-#
-class Goal
-  attr_accessor :goal_id, :name, :link, :num_registered_people, 
-  :num_unregistered_people, :num_say_worth_it,
-  :num_say_not_worth_it, :percentage_worth_it,
-  :tags, :id, :progress_link, :team_link
-
-  def initialize()
-    # just to initialize the object, we'll always feed the attributes in
-    # some other way
-  end
-
-  #
-  # Builds a Goal object from an xml object.  Normally, this is
-  # called by the get_goal_by_id or get_goal_by_name methods of 
-  # an R43::Request object.
-  #
-  def Goal.from_xml(xml)
-    goal = Goal.new()
-
-    goal.goal_id= xml.attributes["goal_id"].to_i
-    goal.name=  xml.elements["name"].text
-    goal.link= xml.elements["link"].attributes["href"]
-
-    if xml.elements["num_registered_people"] then
-      goal.num_registered_people= 
-        xml.elements["num_registered_people"].text.to_i
-    end
-
-    if xml.elements["num_unregistered_people"] then
-      goal.num_unregistered_people= 
-        xml.elements["num_unregistered_people"].text.to_i
-    end
-
-    if xml.elements["worth_it_data"] then
-      goal.num_say_worth_it= 
-        xml.elements["worth_it_data"].elements["num_say_worth_it"].text.to_i
-      goal.num_say_not_worth_it= 
-        xml.elements["worth_it_data"].elements["num_say_not_worth_it"].text.to_i
-      goal.percentage_worth_it= 
-        xml.elements["worth_it_data"].elements["percentage_worth_it"].text.to_i
-    end
-    goal.id= xml.elements["id"].text
-
-    tags = []
-    xml.elements.each("tags/tag") do |tag_element| 
-      tags.push(tag_element.text)
-    end
-    goal.tags= tags
-
-    goal
-  end
-end
-
-module R43
-
-
-  private
-
-  class R43::Service
-    attr_reader :key
-    
-    def initialize(key)
-      @key = key.to_s
-    end
-
-    protected
-
-    #
-    # a private method to add the api_key to the request url
-    #
-    def _inject_key(url)
-      key_str = "api_key=#{@key}"
-      if url =~ /\?$/
-        url + key_str
-      elsif url =~ /\?/
-        url.sub /\?/, "?#{key_str}&"
-      else
-        url + "?" + key_str
-      end
-    end
-
-    #
-    # a private method for getting responses from 43 things.
-    #
-    def _get_response(url)
-      full_url = _inject_key url
-      Net::HTTP.start('www.43things.com') do |http|
-        response = http.get("/service/#{full_url}")
-        if response.code == "200" then
-          xml = REXML::Document.new(response.body)
-        else
-          return response.code
-        end
-      end
-    end
-
-    public
-    
-    def get_response(url)
-      _get_response(_inject_key(url))
-    end
-    
-  end
-
-  public
-  
-  #
-  # Implements the 43 Things API.  This is where you actually
-  # instantiate objects.
-  #
-  #   require 'r43'
-  #   connection = R43::Request.new(<api_key>) 
-  #
-  class R43::Request
-    attr_reader :service
-
-    def initialize(key)
-      @service = R43::Service.new key
-    end
-
-
-    private
-
-    #
-    # a private method for getting responses from 43 things.
-    #
-    def _get_response(url)
-      Response.new(@service, url)
-    end
-
-    public
-
-    #
-    # Implements the echo method from the General API.  Returns a hash
-    # with the keys; <em>api_key</em>, <em>action</em>,
-    # <em>controller</em> 
-    #
-    #   require 'r43'
-    #   connection = R43::Request.new(<api_key>)
-    #   response = connection.echo
-    #
-    def echo()
-      xml = _get_response("echo").xml
-      response = {
-        "api_key" =>  
-          xml.elements["parameters"].elements["api_key"].text,
-        "action" =>
-          xml.elements["parameters"].elements["action"].text,
-        "controller" =>
-          xml.elements["parameters"].elements["controller"].text
-      }
-    end
-
-
-    #
-    # Implements the authentication_test method from the General API.
-    # returns "true" if the connection works.  Only uses the cleartext
-    # username and password at this point
-    #
-    #  require 'r43'
-    #  connection = R43::Request.new(<api_key>)
-    #  response = connection.echo(<username>,<password>)
-    #--
-    # This really needs ATOM style authentication to work properly
-    #++
-    #
-    def authentication_test(username, password)
-      xml = _get_response("authentication_test?username=#{username}&password=#{password}").xml
-      xml.elements["authentication_test"].text
-    end
-
-    #
-    # Implements the get_goal_by_id method from the Goals API.  Returns a
-    # Goal object.
-    #
-    #   require 'r43'
-    #   connection = R43::Request.new(<api_key>)
-    #   goal = connection.get_goal_by_id(255)
-    #
-    def get_goal_by_id(id)
-      _get_response("get_goal_by_id?id=#{id}").goal
-    end
-
-
-    #
-    # Implements the get_goal_by_name method from the Goals API.  Returns
-    # a Goal object
-    #
-    #  require 'r43'
-    #  connection = R43::Request.new(<api_key>)
-    #  goal = connection.get_goal_by_name(<name>)
-    #
-    def get_goal_by_name(name)
-      name = name.gsub!(/\s/, '+')
-      _get_response("get_goal_by_name?name=#{name}").goal
-    end
-
-
-    #
-    # Implements the get_goals_similarities method from the Goals API and
-    # returns an R43::Response containing an array of Goal objects
-    #
-    #
-    #  require 'r43'
-    #  connection = R43::Request.new(<api_key>)
-    #  goals = connection.get_goals_similarities(<id>).goals
-    #
-    def get_goals_similarities(id)
-      _get_response("get_goals_similarities?id=#{id}")
-    end
-
-    #
-    # Implements the search_goals method from the Goals API and
-    # returns an R43::Response containing an array of Goal objects
-    #
-    #
-    #  require 'r43'
-    #  connection = R43::Request.new(<api_key>)
-    #  response = connection.search_goals(<query string>[,
-    #                                     {["offset" => <offset>], 
-    #                                     ["max" => <max>]}])
-    #  goals = response.goals
-    #
-    def search_goals(string, optional={})
-      string.gsub!(/\s/, "+") 
-      if optional["offset"] then
-        string += "&offset=#{optional["offset"]}"
-      end
-      if optional["max"] then
-        string += "&max=#{optional["max"]}"
-      end
-  
-      _get_response("search_goals?q=#{string}")
-    end
-
-    #
-    # Implements the get_goals_people method from the Goals API and
-    # returns an R43:Response containging an array of Person objects
-    #
-    #
-    #  require 'r43'
-    #  connection = R43::Request.new(<api_key>)
-    #  response = connection.get_goals_people(<id>[,
-    #                                         {["offset" => <offset>], 
-    #                                         ["max" => <max>]}])
-    #  people = response.people
-    #
-    def get_goals_people(id, optional={})
-      string = "id=#{id}"
-      if optional["offset"] then
-        string += "&offset=#{optional["offset"]}"
-      end
-      if optional["max"] then
-        string += "&max=#{optional["max"]}"
-      end
-  
-      _get_response("get_goals_people?#{string}")
-    end
-
-    #
-    # Implements the get_goals_entries method from the Goals API and
-    # returns an array of Entry objects
-    #
-    #
-    #  require 'r43'
-    #  connection = R43::Request.new(<api_key>)
-    #  entries = connection.get_goals_entries(<id>,[{["offset" => <offset>], 
-    #                                                ["max" => <max>], 
-    #                                                ["view" => <view>]}])
-    #
-    def get_goals_entries(id, optional={})
-      string = "id=#{id}"
-      if optional["offset"] then
-        string += "&offset=#{optional["offset"]}"
-      end
-      if optional["max"] then
-        string += "&max=#{optional["max"]}"
-      end
-      if optional["view"] then
-        string += "&view=#{optional["view"]}"
-      end
-      
-      _get_response("get_goals_entries?#{string}")
-    end
-
-
-
-    #
-    # Implements the get_person method from the People API and returns a
-    # Person object.  If the optional true or false value is set to true,
-    # the username is treated as a flickr username instead of a 43 Things
-    # username.  If the value is false or not set, the username is treated 
-    # as a 43 Things username.
-    #
-    #  require 'r43'
-    #  connection = R43::Request.new(<api_key>)
-    #  person = connection.get_person(<username>[, <true|false>])
-    #
-    def get_person(id,use_flickr=false)
-      if (use_flickr)
-        id_cmd = "flickr_username"
-      else
-        id_cmd = "id"
-      end
-      _get_response("get_person?#{id_cmd}=#{id}").person
-    end
-
-
-    #
-    # Implements the get_entry method of the Entries API
-    #
-    #   require 'r43'
-    #   connection = R43::Request.new(<api_key>)
-    #   connection.get_entry(<id>)
-    #
-
-    def get_entry(id)
-      _get_response("get_entry?id=#{id}").entry
-    end
-
-    #
-    # Implements the search_cities method of the Cities API
-    #
-    #   require 'r43'
-    #   connection = R43::Request.new(<api_key>)
-    #   connection.search_cities(<query>)
-    #
-
-    def search_cities(query)
-      _get_response("search_cities?q=#{query}").cities
-    end
-    
-    #
-    # Implements the get_city method of the Cities API
-    #
-    #   require 'r43'
-    #   connection = R43::Request.new(<api_key>)
-    #   connection.get_city(<id>)
-    #
-
-    def get_city(id)
-      _get_response("get_city?id=#{id}").city
-    end
-
-    #
-    # Implements the get_citys_people method of the Cities API
-    #
-    #   require 'r43'
-    #   connection = R43::Request.new(<api_key>)
-    #   connection.get_citys_people(<id>)
-    #
-
-    def get_citys_people(id, optional={})
-      params = "id=#{id}"
-      params += "&offset=#{optional["offset"]}" if optional["offset"]
-      params += "&max=#{optional["max"]}" if optional["max"]
-
-      _get_response("get_citys_people?#{params}").people
-    end
-    
-  end
-
-  class R43::Response
-    attr_reader :service, :query, :xml,
-                :object,  :entry,   :person, :goal, :city,
-                :objects, :entries, :people, :goals, :cities, :tags,
-                :has_object, :max_in_page, :total_available, :next_offset
-
-    def initialize(service, query)
-      @service = service
-      @query = query
-      @has_object = false
-      @objects = []
-      @entries = []
-      @people = []
-      @goals = []
-      @cities = []
-      @tags = []
-      @max_in_page = 0
-      @total_available = 0
-      @next_offset = 0
-      _from_xml(service.get_response(query))
-    end
-
-    def more()
-      _populate_collections_from_xml(service.get_response(query + "&offset=#{@next_offset}"))
-    end
-
-    private
-    
-    def object=(object)
-      if @has_object
-        @object = nil
-      else
-        @has_object = true
-        @object = object
-      end
-    end
-
-    def entry=(entry)
-      @entry = entry
-      self.object = @entry
-      add_entry(@entry)
-    end
-
-    def person=(person)
-      @person = person
-      self.object = @person
-      add_person @person
-    end
-
-    def goal=(goal)
-      @goal = goal
-      self.object = @goal
-      add_goal @goal
-    end
-
-    def city=(city)
-      @city = city
-      self.object = @city
-      add_city @city
-    end
-
-    def add_entry(entry)
-      @entries.push entry
-      @objects.push entry
-    end
-
-    def add_person(person)
-      @people.push person
-      @objects.push person
-    end
-
-    def add_goal(goal)
-      @goals.push goal
-      @objects.push goal
-    end
-
-    def add_city(city)
-      @cities.push city
-      @objects.push city
-    end
-
-    def add_tag(tag)
-      @tags.push tag
-      @objects.push tag
-    end
-
-    def _from_xml(xml)
-      @xml = xml
-      self.entry = Entry.from_xml(xml.elements["entry"]) if xml.elements["entry"]
-      self.person = Person.from_xml(xml.elements["person"]) if xml.elements["person"]
-      self.goal = Goal.from_xml(xml.elements["goal"]) if xml.elements["goal"]
-      self.city = City.from_xml(xml.elements["city"]) if xml.elements["city"]
-      _populate_collections_from_xml xml
-    end
-
-    def _populate_collections_from_xml(xml)
-      if xml.elements["feed/pagination"] then
-        @max_per_page = xml.elements["feed/pagination/max"].text.to_i
-        @total_available = xml.elements["feed/pagination/total"].text.to_i
-        @next_offset = xml.elements["feed/pagination/next_offset"].text.to_i
-      end
-      
-      xml.elements.each("feed/entry") do |entry_element|
-        add_entry(Entry.from_xml(entry_element))
-      end
-
-      xml.elements.each("feed/person") do |person_element|
-        add_person(Person.from_xml(person_element))
-      end
-
-      xml.elements.each("feed/goal") do |goal_element|
-        add_goal(Goal.from_xml(goal_element))
-      end
-
-      xml.elements.each("feed/city") do |city_element|
-        add_city(City.from_xml(city_element))
-      end
-    end
-  end
-end