plancast 0.0.2 → 0.1.0

data/lib/plancast.rb

@@ -7,6 +7,30 @@ Hash.send :include, Hashie::HashExtensions
 
 module Plancast
   
+  VERSION = "0.1.0".freeze
+  
+  def self.configure
+    yield self
+    true
+  end
+  
+  def self.api_url(endpoint, version = self.api_version)
+    "http://api.plancast.com/#{version}#{endpoint}.json"
+  end
+
+  # class << self
+  #   attr_accessor :api_key
+  #   attr_accessor :api_version
+  # end
+  
+  def self.api_version
+    @api_version || "02"
+  end
+  
+  def self.api_version=(value)
+    @api_version = value
+  end
+  
   class PlancastError < StandardError
     attr_reader :data
 

data/lib/plancast/client.rb

@@ -1,7 +1,7 @@
 module Plancast
   class Client
     include HTTParty
-    base_uri 'api.plancast.com/01'
+    base_uri "api.plancast.com/#{Plancast.api_version}"
     format :json
     
     attr_reader :username
@@ -12,62 +12,91 @@ module Plancast
     end
     
     def verify_credentials
-      Hashie::Mash.new(self.class.get("/account/verify_credentials.json"))
+      self.class.get("/account/verify_credentials.json")
     end
     
-    def home_timeline
-      Hashie::Mash.new(self.class.get("/plans/home_timeline.json"))
+    def user(query={})
+      self.class.get("/users/show.json", :query => query)
     end
     
-    def user_timeline(username=self.username)
-      timeline = Hashie::Mash.new(self.class.get("/plans/user_timeline.json"))
+    def subscriptions(query={})
+      self.class.get("/users/subscriptions.json", :query => query)
     end
     
-    def update(details={})
-      plan = Hashie::Mash.new(self.class.post("/plans/update.json", :body => details))
+    def update_subscription(options={})
+      self.class.post("/subscriptions/update.json", :body => options)
     end
     
-    def attend(plan_id)
-      plan = Hashie::Mash.new(self.class.post("/plans/attend.json", :query => {:plan_id => plan_id}))
+    def destroy_subscription(options={})
+      self.class.post("/subscriptions/destroy.json", :body => options)
     end
     
-    def unattend(attendance_id)
-      plan = Hashie::Mash.new(self.class.post("/plans/destroy.json", :query => {:attendance_id => attendance_id}))
+    def subscribers(query={})
+      self.class.get("/users/subscribers.json", :query => query)
     end
     
-    def plan(attendance_id)
-      plan = Hashie::Mash.new(self.class.get("/plans/show.json", :query => {:attendance_id => attendance_id}))
+    def discover_friends(query={})
+      self.class.get("/users/discover_friends.json", :query => query)
     end
     
-    def search_plans(q, options={})
-      results = Hashie::Mash.new(self.class.get("/plans/search.json", :query => options.merge({:q => q})))
+    def search_users(q, options={})
+      self.class.get("/users/search.json", :query => options.merge({:q => q}))
     end
     
-    def user(screen_name=nil)
-      user = Hashie::Mash.new(self.class.get("/users/show.json", :query => {:screen_name => screen_name}))
+    def plans(query = {})
+      self.class.get("/plans/user.json", :query => query)
     end
     
-    def search_users(q, options={})
-      results = Hashie::Mash.new(self.class.get("/users/search.json", :query => options.merge({:q => q})))
+    def home
+      self.class.get("/plans/home.json")
+    end    
+    
+    def plan(query = {})
+      self.class.get("/plans/show.json", :query => query)
     end
     
-    def subscriptions(user_id)
-      results = self.class.get("/users/subscriptions.json", :query => {:user_id => user_id}).map{|s| Hashie::Mash.new(s)}
+    def search_plans(query)
+      self.class.get("/plans/search.json", :query => query)
     end
     
-    def subscribers(user_id)
-      results = self.class.get("/users/subscribers.json", :query => {:user_id => user_id}).map{|s| Hashie::Mash.new(s)}
+    def parse_when(q)
+      date = self.class.get("/plans/parse_when.json", :query => {:when => q})
+      date.start = Time.at(date.start)
+      date.stop = Time.at(date.stop)
+      date
     end
     
-    def create_comment(details={})
-      comment = Hashie::Mash.new(self.class.post("/comments/update.json", :body => details))
+    def parse_where(where)
+      locations = self.class.get("/plans/parse_where.json", :query => {:where => where})
+      locations.each{|l| l.latitude = l.latitude.to_f; l.longitude = l.longitude.to_f}
+      locations
     end
     
-    def create_friendship(user_id)
-      user = Hashie::Mash.new(self.class.post("/friendships/create.json", :body => {:user_id => user_id}))
+    def update(details={})
+      self.class.post("/plans/update.json", :body => details)
+    end
+    
+    def attend(details={})
+      self.class.post("/plans/attend.json", :body => details)
     end
 
+    def user_timeline(username=self.username)
+      self.class.get("/plans/user_timeline.json")
+    end
+    
+    def unattend(options)
+     self.class.post("/plans/destroy.json", :body => options)
+    end
+    
+    def update_comment(details={})
+      self.class.post("/comments/update.json", :body => details)
+    end
     
+    def destroy_comment(comment_id)
+      self.class.post("/comments/destroy.json", :body => {:comment_id => comment_id})
+    end
+    
+
     def self.get(*args); handle_response super end
     def self.post(*args); handle_response super end
     
@@ -80,7 +109,11 @@ module Plancast
       when 500...600; raise ServerError.new(response.code)
       else; response
       end
-      response
+      if response.is_a?(Array)
+        response.map{|item| Hashie::Mash.new(item)}
+      else
+        Hashie::Mash.new(response)
+      end
     end
     
   end

data/test/helper.rb

@@ -2,11 +2,10 @@ require 'rubygems'
 require 'test/unit'
 require 'shoulda'
 
-require 'shoulda'
+require 'redgreen'
 require 'matchy'
 require 'fakeweb'
 
-
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'plancast'
@@ -16,6 +15,9 @@ require 'plancast'
 # You don't usually want your test suite to make HTTP connections, do you?
 FakeWeb.allow_net_connect = false
 
+class Test::Unit::TestCase
+end
+
 def fixture_file(filename)
   return '' if filename == ''
   file_path = File.expand_path(File.dirname(__FILE__) + '/fixtures/' + filename)
@@ -25,7 +27,7 @@ end
 def plancast_url(url, options={})
   options[:username] ||= 'pengwynn'
   options[:password] ||= 'password'
-  url =~ /^http/ ? url : "http://#{options[:username]}:#{options[:password]}@api.plancast.com/01#{url}"
+  url =~ /^http/ ? url : "http://#{options[:username]}:#{options[:password]}@api.plancast.com/#{Plancast.api_version}#{url}"
 end
 
 def stub_request(method, url, filename, status=nil)
@@ -40,5 +42,4 @@ end
 def stub_get(*args); stub_request(:get, *args) end
 def stub_post(*args); stub_request(:post, *args) end
 
-class Test::Unit::TestCase
-end
+

data/test/plancast_test.rb

@@ -0,0 +1,159 @@
+require 'helper'
+
+class PlancastTest < Test::Unit::TestCase
+  
+  context "Plancast API" do
+    
+    setup do
+      @client = Plancast::Client.new('pengwynn', 'password')
+    end
+
+    should "verify credentials" do
+      
+      stub_get("/account/verify_credentials.json", "verify_credentials.json")      
+      lambda {@client.verify_credentials}.should_not raise_error
+      user = @client.verify_credentials
+      user.username.should == 'pengwynn'
+      user.name.should == 'Wynn Netherland'
+      
+    end
+    
+    should "raise error on invalid credentials" do
+      stub_get("/account/verify_credentials.json", "", ['401'])      
+      lambda {@client.verify_credentials}.should raise_error(Plancast::Unauthorized)
+    end
+
+    should "get the details of a user" do
+      stub_get("/users/show.json?user_id=1", "user.json")
+      user = @client.user(:user_id => 1)
+      user.name.should == 'Mark Hendrickson'
+      user.twitter_username.should == 'mhendric'
+    end
+    
+    should "get a users's subscription" do
+      stub_get("/users/subscriptions.json?user_id=30", "subscriptions.json")
+      subscriptions = @client.subscriptions(:user_id => 30).users
+      subscriptions.size.should == 25
+      subscriptions.first.screen_name = 'ifindkarma'
+    end
+    
+    should "get a user's subscribers" do
+      stub_get("/users/subscribers.json?user_id=1", "subscriptions.json")
+      subscribers = @client.subscribers(:user_id => 1).users
+      subscribers.size.should == 25
+      subscribers.first.screen_name = 'ifindkarma'
+    end
+    
+    should "get users who are friends of a particular user on Facebook or Twitter" do
+      stub_get("/users/discover_friends.json?service=twitter", "discover_friends.json")
+      response = @client.discover_friends(:service => :twitter)
+      subscriptions = response.users
+      subscriptions.size.should == 25
+      subscriptions.first.screen_name = 'graysky'
+      response.has_next_page?.should == true
+    end
+    
+    should "search for users by keyword" do
+      stub_get("/users/search.json?q=mark", "users_search.json")
+      response = @client.search_users('mark')
+      results = response.results
+      results.first.username.should == "mark"
+    end
+
+    should "create or update a subscription" do
+      stub_post("/subscriptions/update.json", "update_subscription.json")
+      subscription = @client.update_subscription(:user_id => 1)
+      subscription.username.should == "peter"
+    end
+    
+    should "delete a subscription" do
+      stub_post("/subscriptions/destroy.json", "destroy_subscription.json")
+      subscription = @client.destroy_subscription(:user_id => 1)
+      subscription.username.should == "peter"
+    end
+
+    should "get the plans of a user" do
+      stub_get("/plans/user.json?username=mark", "user_plans.json")
+      response = @client.plans(:username => 'mark')
+      plans = response.plans
+      plans.first.attendance_url.should == 'http://plancast.com/a/32st'
+    end
+    
+    should "get the home timeline of a user (his plans + his friends' plans)" do
+      stub_get("/plans/home.json", "home.json")
+      timeline = @client.home
+      timeline.plans.size.should == 19
+      timeline.plans.first.attendance_id.should == '10o'
+    end
+    
+    should "get the details of a plan" do
+      stub_get("/plans/show.json?plan_id=enf", "plan.json")
+      plan = @client.plan(:plan_id => 'enf')
+      plan.plan_id.should == 'enf'
+      plan.creator.username.should == 'ethan'
+    end
+    
+    should "create or update a plan" do
+      stub_post("/plans/update.json", "new_plan.json")
+      details = {
+        :what => "Test Plancast gem",
+        :when => "tomorrow"
+      }
+      plan = @client.update(details)
+      plan.attendance_id.should == '3ag4'
+    end
+    
+    should "add an attendance to a plan for a user" do
+      stub_post("/plans/attend.json", "attend.json")
+      info = {
+        :attendance_id => 'dho',
+        :syndicate_twitter => false
+      }
+      attendance = @client.attend(info)
+      attendance.attendance_id.should == '3ag6'
+    end
+    
+    should "delete or unattend a plan" do
+      stub_post("/plans/destroy.json", "plan.json")
+      attendance = @client.unattend(:plan_id => 'enf')
+      attendance.creator.username.should == 'ethan'
+    end
+    
+    should "search plans by keyword" do
+      stub_get("/plans/search.json?q=party", "plans_search.json")
+      plans = @client.search_plans(:q => 'party').plans
+      plans.first.plan_id.should == "5bz"
+    end
+    
+    should "parse datetime from a string" do
+      stub_get("/plans/parse_when.json?when=next%20friday", "parse_when.json")
+      date = @client.parse_when("next friday")
+      date.start.year.should == 2010
+      date.start.month.should == 5
+      date.stop.day.should == 28
+    end
+    
+    should "parse location from string" do
+      stub_get("/plans/parse_where.json?where=london", "parse_where.json")
+      locations = @client.parse_where("london")
+      locations.first.latitude.should == 51.500152
+      locations.first.longitude.should == -0.126236
+    end
+
+    should "create a comment" do
+      stub_post("/comments/update.json", "comment.json")
+      comment = @client.update_comment(:content => "hello world")
+      comment.content.should == 'hello world'
+    end
+    
+    should "delete a comment" do
+      stub_post("/comments/destroy.json", "comment.json")
+      comment = @client.destroy_comment(7513)
+      comment.content.should == 'hello world'
+    end
+  
+  end
+  
+  
+  
+end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: plancast
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Wynn Netherland
@@ -9,134 +14,148 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-21 00:00:00 -05:00
+date: 2010-05-22 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: hashie
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        - 3
         version: 0.1.3
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: httparty
+  name: hashie
+  prerelease: false
+  requirement: *id001
   type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.5.0
-    version: 
+        segments: 
+        - 0
+        - 1
+        - 0
+        version: 0.1.0
+  name: monster_mash
+  prerelease: false
+  requirement: *id002
+  type: :runtime
 - !ruby/object:Gem::Dependency 
-  name: shoulda
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 7
+        - 6
+        version: 0.7.6
+  name: yajl-ruby
+  prerelease: false
+  requirement: *id003
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 10
+        - 1
         version: 2.10.1
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: matchy
+  name: shoulda
+  prerelease: false
+  requirement: *id004
   type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 4
+        - 0
         version: 0.4.0
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: fakeweb
+  name: matchy
+  prerelease: false
+  requirement: *id005
   type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 5
         version: 1.2.5
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: yard
+  name: fakeweb
+  prerelease: false
+  requirement: *id006
   type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
-description: Wrapper for the unpublished Plancast API
+  name: yard
+  prerelease: false
+  requirement: *id007
+  type: :development
+description: Wrapper for the Plancast API
 email: wynn.netherland@gmail.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- LICENSE
-- README.rdoc
+extra_rdoc_files: []
+
 files: 
-- .document
-- .gitignore
-- LICENSE
-- README.rdoc
-- Rakefile
-- VERSION
-- lib/plancast.rb
 - lib/plancast/client.rb
-- plancast.gemspec
-- test/fixtures/attend.json
-- test/fixtures/comment.json
-- test/fixtures/create_friendship.json
-- test/fixtures/featured.json
-- test/fixtures/home_timeline.json
-- test/fixtures/parse_when.json
-- test/fixtures/plan.json
-- test/fixtures/search.json
-- test/fixtures/subscribers.json
-- test/fixtures/subscriptions.json
-- test/fixtures/unattend.json
-- test/fixtures/update.json
-- test/fixtures/user.json
-- test/fixtures/user_search.json
-- test/fixtures/user_timeline.json
-- test/fixtures/verify_credentials.json
-- test/helper.rb
-- test/test_plancast.rb
+- lib/plancast.rb
 has_rdoc: true
 homepage: http://github.com/pengwynn/plancast
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: Wrapper for the unpublished Plancast API
+summary: Wrapper for the Plancast API
 test_files: 
 - test/helper.rb
-- test/test_plancast.rb
+- test/plancast_test.rb