convore 0.0.0 → 0.0.1

data/README.md

@@ -1,11 +1,16 @@
 Convore API
 ===========
 
-Quick implementation of the Convore.com API in ruby.
+Convore!
+-----
+Convore's ruby gem!
+
 
 Usage
 -----
 
+Client:
+
 	require 'convore'
 
 	@client = Convore::Client.new

data/convore.gemspec

@@ -6,10 +6,10 @@ Gem::Specification.new do |s|
   s.name        = "convore"
   s.version     = Convore::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Marian Rudzynski"]
-  s.email       = ["mr@impaled.org"]
+  s.authors     = ["Marian Rudzynski", "RyanonRails"]
+  s.email       = ["mr@impaled.org", "Ryan.Michael.Jones@gmail.com"]
   s.homepage    = ""
-  s.summary     = %q{A hasty convore.com API implementation in ruby}
+  s.summary     = %q{A convore.com API implementation in ruby}
   s.description = %q{}
 
   # s.rubyforge_project = "convore"

data/lib/convore.rb

@@ -4,14 +4,13 @@ require 'json'
 module Convore
 end
 
-require 'convore/version'
-
-require 'convore/api'
-require 'convore/base'
-require 'convore/user'
-require 'convore/group'
-require 'convore/topic'
-require 'convore/message'
-require 'convore/star'
-require 'convore/client'
+require_relative 'convore/version'
 
+require_relative 'convore/api'
+require_relative 'convore/base'
+require_relative 'convore/user'
+require_relative 'convore/group'
+require_relative 'convore/topic'
+require_relative 'convore/message'
+require_relative 'convore/client'
+require_relative 'convore/account' 

data/lib/convore/account.rb

@@ -0,0 +1,33 @@
+require 'rest-client'
+
+module Convore
+	class Account < Base
+		attr_accessor :username, :password
+
+		def initialize(username, password)
+			@username = username
+			@password = password
+		end
+		
+		#Use this method to check if the user is properly logged in (also get user id)
+		def verified?
+			RestClient.get "https://#{@username}:#{@password}@convore.com/api/account/verify.json"
+		end
+		
+		#Mark all messages as read
+		def mark_all_read
+			RestClient.post "https://#{@username}:#{@password}@convore.com/api/account/mark_read.json", {}
+		end
+		
+		#Get members online now
+		def get_members_online
+			RestClient.get "https://#{@username}:#{@password}@convore.com/api/account/online.json"
+		end
+		
+		#Get the users mentions
+		def get_mentions
+			RestClient.get "https://#{@username}:#{@password}@convore.com/api/account/online.json"
+		end
+
+	end
+end

data/lib/convore/base.rb

@@ -1,11 +1,12 @@
 module Convore
 	class Base
-		attr_accessor :attributes
+		attr_accessor :attributes, :username, :password
 
 		def initialize
 			@attributes ||= {}
 		end
 
+		
 		def method_missing(method, *args)
 			if method.match(/\=/)
 				@attributes[method.to_s.gsub(/\=$/, '').to_sym] = args.first
@@ -15,6 +16,7 @@ module Convore
 			end
 			raise NoMethodError.new("no such method: #{method}")
 		end
+		
 
 		class << self
 

data/lib/convore/group.rb

@@ -1,5 +1,100 @@
+#If posts don't have a mandatory payload they need to be fed a hash {}
+require 'rest-client'
+
 module Convore
 	class Group < Base
+		attr_accessor :username, :password
+
+		def initialize(username, password)
+			@username = username
+			@password = password
+		end
+		
+		#Get a list of the current user's groups
+		def get_groups
+			RestClient.get "https://#{@username}:#{@password}@convore.com/api/groups.json"
+		end
+		
+		#Create a new group.
+		def create_group(hash)
+			RestClient.post "https://#{@username}:#{@password}@convore.com/api/groups/create.json",
+				{:name => hash[:name],
+				 :kind => hash[:kind],
+				 #from here down optional
+				 :description => hash[:description],
+				 :slug => hash[:slug]}
+		end
+		
+		#Get detailed information about the group
+		def get_group_info(group_id)
+			if group_id.integer?
+				RestClient.get "https://#{@username}:#{@password}@convore.com/api/groups/#{group_id}.json"
+			end
+		end
+		
+		#Get the group members
+		def get_group_members(group_id, *hash)
+			if group_id.integer?
+				RestClient.get "https://#{@username}:#{@password}@convore.com/api/groups/#{group_id}/members.json",
+				#from here down optional
+				#{:filter => hash[:admin]}
+				hash[0]
+			end
+		end
+		
+		#Join a public group
+		def join_public_group(group_id)
+			if group_id.integer?
+				RestClient.post "https://#{@username}:#{@password}@convore.com/api/groups/#{group_id}/join.json", {}
+			end
+		end
+		
+		#Requests to join a private group
+		def join_private_group(group_id)
+			if group_id.integer?
+				RestClient.post "https://#{@username}:#{@password}@convore.com/api/groups/#{group_id}/request.json", ()
+			end
+		end
+		
+		#Leave a group
+		def leave_group(group_id)
+			if group_id.integer?
+				RestClient.post "https://#{@username}:#{@password}@convore.com/api/groups/#{group_id}/leave.json", {}
+			end
+		end
+		
+		#Get group members online now
+		def get_online_members(group_id)
+			if group_id.integer?
+				RestClient.post "https://#{@username}:#{@password}@convore.com/api/groups/#{group_id}/online.json", {}
+			end
+		end
+		
+		#Get the latest topics in a group
+		def get_latest_topics(group_id, *hash)
+			if group_id.integer?
+				RestClient.get "https://#{@username}:#{@password}@convore.com/api/groups/#{group_id}/topics.json",
+				#from here down optional (pagination)
+				#{:until_id => hash[:until_id]}
+				hash[0]
+			end
+		end
+		
+		#Create a new topic
+		def create_topic(group_id, hash)
+			if group_id.integer?
+				RestClient.post "https://#{@username}:#{@password}@convore.com/api/groups/#{group_id}/topics/create.json",
+				{:name => hash[:name]}
+			end
+		end
+		
+		#Mark all messages in the group as read
+		def mark_all_read(group_id)
+			if group_id.integer?
+				RestClient.post "https://#{@username}:#{@password}@convore.com/api/groups/#{group_id}/mark_read.json", {}
+			end
+		end	
+		
 		def self.api
 			'group'
 		end

data/lib/convore/message.rb

@@ -1,7 +1,25 @@
 module Convore
 	class Message < Base
-		def text
-			message
+		
+		def initialize(username, password)
+			@username = username
+			@password = password
 		end
+		
+		#Star a message. If the message has already been starred by this user,
+		# this endpoint will then unstar the message.
+		def star_message(message_id)
+			if message_id.integer?
+				RestClient.post "https://#{@username}:#{@password}@convore.com/api/messages/#{message_id}/star.json", {}
+			end
+		end
+		
+		#Delete a message. You must be the creator of the message or a group admin in order to delete the message.
+		def delete_message(message_id)
+			if message_id.integer?
+				RestClient.post "https://#{@username}:#{@password}@convore.com/api/messages/#{message_id}/delete.json", {}
+			end
+		end
+
 	end
 end

data/lib/convore/topic.rb

@@ -1,5 +1,62 @@
 module Convore
 	class Topic < Base
+		
+		def initialize(username, password)
+			@username = username
+			@password = password
+		end
+		
+		#Get detailed information about the topic
+		def get_topic(topic_id)
+			if topic_id.integer?
+				RestClient.get "https://#{@username}:#{@password}@convore.com/api/topics/#{topic_id}.json"
+			end
+		end
+		
+		#Get the latest messages in a topic. Use the optional until_id parameter
+		#to paginate and get prior messages. Set the optional mark_read parameter
+		#to false to leave the messages as unread
+		def get_topic_messages(topic_id, *hash)
+			if topic_id.integer?
+				RestClient.get "https://#{@username}:#{@password}@convore.com/api/topics/#{topic_id}/messages.json",
+				#Optional Parms
+				#until_id
+				#mark_read
+				hash[0]
+			end
+		end
+		
+		#Post a new message
+		def create_message(topic_id, hash)
+			if topic_id.integer?
+				RestClient.post "https://#{@username}:#{@password}@convore.com/api/topics/#{topic_id}/messages/create.json",
+				{:message => hash[:message]}
+			end
+		end
+		
+		#Delete a topic. You must be the creator of the topic or a
+		# group admin in order to delete the topic.
+		def delete_topic(topic_id)
+			if topic_id.integer?
+				RestClient.post "https://#{@username}:#{@password}@convore.com/api/topics/#{topic_id}/delete.json", {}
+			end
+		end
+		
+		#Edit a topic. You must be the creator of the topic or a group admin in order to edit the topic.
+		def edit_topic(topic_id, hash)
+			if topic_id.integer?
+				RestClient.post "https://#{@username}:#{@password}@convore.com/api/topics/#{topic_id}/edit.json",
+				{:name => hash[:name]}
+			end
+		end
+		
+		#Mark all messages in a topic as read
+		def mark_read(topic_id)
+			if topic_id.integer?
+				RestClient.post "https://#{@username}:#{@password}@convore.com/api/topics/#{topic_id}/mark_read.json", {}
+			end
+		end
+		
 		def self.api
 			'topic'
 		end

data/lib/convore/user.rb

@@ -1,4 +1,16 @@
 module Convore
 	class User < Base
+		
+		def initialize(username, password)
+			@username = username
+			@password = password
+		end
+		
+		#Get detailed information about the user
+		def get_info(user_id)
+			if user_id.integer?
+				RestClient.get "https://#{@username}:#{@password}@convore.com/api/users/#{user_id}.json"
+			end
+		end
 	end
 end

data/lib/convore/version.rb

@@ -1,3 +1,3 @@
 module Convore
-	VERSION = "0.0.0"
+	VERSION = "0.0.1"
 end

data/test/test_account.rb

@@ -0,0 +1,39 @@
+#TODO: More robust checkingthen 200, works for now though
+
+require 'test/unit'
+require '../lib/convore'
+
+class Test_Account < Test::Unit::TestCase
+  
+  def setup
+    @username = 'Botticus'
+    @password = 'bot123'
+  end
+  
+  def test_verified?
+    account = Convore::Account.new(@username, @password)
+    response = account.verified?
+    assert_equal(response.code, 200)
+  end
+  
+  def test_mark_all_read
+    account = Convore::Account.new(@username, @password)
+    response = account.mark_all_read
+    assert_equal(response.code, 200)
+  end
+  
+  def test_get_members_online
+    account = Convore::Account.new(@username, @password)
+    response = account.get_members_online
+    assert_equal(response.code, 200)
+  end
+  
+  def test_get_mentions
+    account = Convore::Account.new(@username, @password)
+    response = account.get_mentions
+    assert_equal(response.code, 200)
+  end
+  
+end
+
+

data/test/test_group.rb

@@ -0,0 +1,98 @@
+require 'test/unit'
+require '../lib/convore'
+
+class Test_Group < Test::Unit::TestCase
+  
+  def setup
+    @username = 'Botticus'
+    @password = 'bot123'
+  end
+  
+  
+  def test_get_groups
+    group = Convore::Group.new(@username, @password)
+    response = group.get_groups
+    assert_equal(response.code, 200)
+  end
+  
+  def test_create_group
+    group = Convore::Group.new(@username, @password)
+    hash = {:name => 'testgroup', :kind => 'private',
+            :description => 'this is a test group', :slug => 'test' }
+    response = group.create_group(hash)    
+    assert_equal(response.code, 200)
+  end
+  
+  def test_get_group_info
+    group = Convore::Group.new(@username, @password)
+    response = group.get_group_info(7939)    
+    assert_equal(response.code, 200)
+  end
+  
+  #1 parms
+  def test_get_group_members_1
+    group = Convore::Group.new(@username, @password)
+    response = group.get_group_members(7939)    
+    assert_equal(response.code, 200)
+  end
+  
+  #2 parms
+  def test_get_group_members_2
+    group = Convore::Group.new(@username, @password)
+    response = group.get_group_members(7939, {:filter => 'admin'})    
+    assert_equal(response.code, 200)
+  end
+  
+  def test_join_public_group
+    group = Convore::Group.new(@username, @password)
+    response = group.join_public_group(7939)    
+    assert_equal(response.code, 200)
+  end
+  
+  def test_join_private_group
+    group = Convore::Group.new(@username, @password)
+    response = group.join_public_group(8595)    
+    assert_equal(response.code, 200)
+  end
+  
+  def test_leave_group
+    group = Convore::Group.new(@username, @password)
+    response = group.leave_group(7939)    
+    assert_equal(response.code, 200)
+  end
+
+  def test_get_online_members
+    group = Convore::Group.new(@username, @password)
+    response = group.leave_group(7939)    
+    assert_equal(response.code, 200)
+  end
+  
+  #1 parm
+  def test_get_latest_topics_1
+    group = Convore::Group.new(@username, @password)
+    response = group.get_latest_topics(7939)    
+    assert_equal(response.code, 200)
+  end
+  
+  #2 parm
+  def test_get_latest_topics_2
+    group = Convore::Group.new(@username, @password)
+    response = group.get_latest_topics(7939, {:until_id => 1})    
+    assert_equal(response.code, 200)
+  end
+  
+  def test_create_topic
+    group = Convore::Group.new(@username, @password)
+    response = group.create_topic(8482, {:name => "I am a test topic"})    
+    assert_equal(response.code, 200)
+  end
+  
+  def test_mark_all_read
+    group = Convore::Group.new(@username, @password)
+    response = group.mark_all_read(8482)    
+    assert_equal(response.code, 200)
+  end
+  
+end
+
+

data/test/test_message.rb

@@ -0,0 +1,24 @@
+require 'test/unit'
+require '../lib/convore'
+
+class Test_Message < Test::Unit::TestCase
+  
+  def setup
+    @username = 'Botticus'
+    @password = 'bot123'
+  end
+  
+  
+  def test_star_message
+    message = Convore::Message.new(@username, @password)
+    response = message.star_message(8595)
+    assert_equal(response.code, 200)
+  end
+  
+  def test_delete_message
+    message = Convore::Message.new(@username, @password)
+    response = message.delete_message(8595)
+    assert_equal(response.code, 200)
+  end
+
+end

data/test/test_topic.rb

@@ -0,0 +1,48 @@
+require 'test/unit'
+require '../lib/convore'
+
+class Test_Topic < Test::Unit::TestCase
+  
+  def setup
+    @username = 'Botticus'
+    @password = 'bot123'
+  end
+  
+  
+  def test_get_topic
+    topic = Convore::Topic.new(@username, @password)
+    response = topic.get_topic(8595)
+    assert_equal(response.code, 200)
+  end
+  
+  def test_get_topic_messages
+    topic = Convore::Topic.new(@username, @password)
+    response = topic.get_topic_messages(8595, { :until_id => 11, :mark_read => 'false'})
+    assert_equal(response.code, 200)
+  end
+  
+  def test_create_message
+    topic = Convore::Topic.new(@username, @password)
+    response = topic.get_topic_messages(8595, {:message => 'waffles123123'})
+    assert_equal(response.code, 200)
+  end
+  
+  def test_delete_topic
+    topic = Convore::Topic.new(@username, @password)
+    response = topic.delete_topic(8595)
+    assert_equal(response.code, 200)
+  end
+  
+  def test_edit_topic
+    topic = Convore::Topic.new(@username, @password)
+    response = topic.edit_topic(8595, {:topic_text => "Y so srs?"} )
+    assert_equal(response.code, 200)
+  end
+  
+  def test_mark_read
+    topic = Convore::Topic.new(@username, @password)
+    response = topic.mark_read(8595 )
+    assert_equal(response.code, 200)
+  end
+
+end

data/test/test_user.rb

@@ -0,0 +1,18 @@
+require 'test/unit'
+require '../lib/convore'
+
+class Test_User < Test::Unit::TestCase
+  
+  def setup
+    @username = 'Botticus'
+    @password = 'bot123'
+  end
+  
+  
+  def test_get_info
+    message = Convore::User.new(@username, @password)
+    response = message.get_info(8595)
+    assert_equal(response.code, 200)
+  end
+
+end

metadata

@@ -5,22 +5,24 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 0
-  version: 0.0.0
+  - 1
+  version: 0.0.1
 platform: ruby
 authors: 
 - Marian Rudzynski
+- RyanonRails
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2011-02-15 00:00:00 +01:00
+date: 2011-04-18 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
 description: ""
 email: 
 - mr@impaled.org
+- Ryan.Michael.Jones@gmail.com
 executables: []
 
 extensions: []
@@ -34,16 +36,20 @@ files:
 - Rakefile
 - convore.gemspec
 - lib/convore.rb
+- lib/convore/account.rb
 - lib/convore/api.rb
 - lib/convore/base.rb
 - lib/convore/client.rb
 - lib/convore/group.rb
-- lib/convore/mention.rb
 - lib/convore/message.rb
-- lib/convore/star.rb
 - lib/convore/topic.rb
 - lib/convore/user.rb
 - lib/convore/version.rb
+- test/test_account.rb
+- test/test_group.rb
+- test/test_message.rb
+- test/test_topic.rb
+- test/test_user.rb
 has_rdoc: true
 homepage: ""
 licenses: []
@@ -75,6 +81,10 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: A hasty convore.com API implementation in ruby
-test_files: []
-
+summary: A convore.com API implementation in ruby
+test_files: 
+- test/test_account.rb
+- test/test_group.rb
+- test/test_message.rb
+- test/test_topic.rb
+- test/test_user.rb

data/lib/convore/mention.rb

@@ -1,4 +0,0 @@
-module Convore
-	class Mention < Base
-	end
-end

data/lib/convore/star.rb

@@ -1,17 +0,0 @@
-module Convore
-	class Star < Base
-		class << self
-			def from_json(json)
-				object = new
-				object.user = User.from_json(json['user'])
-				object.message = Message.from_json(json['star']['message'])
-				object.star = json['kind'] == 'star' ? true : false
-				object
-			end
-		end
-		
-		def star?
-			star
-		end
-	end
-end