em-convore 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in convore.gemspec
+gemspec

data/README.md

@@ -0,0 +1,12 @@
+Convore API
+===========
+
+Convore!
+-----
+Convore's ruby gem using eventmachine!
+
+
+Usage
+-----
+
+TODO

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/convore.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "convore/version"
+
+Gem::Specification.new do |s|
+  s.name        = "em-convore"
+  s.version     = Convore::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Carlos Vilhena"]
+  s.email       = ["carlosvilhena@gmail.com"]
+  s.homepage    = "http://carvil.github.com"
+  s.summary     = %q{A convore.com API implementation in ruby using EM}
+  s.description = %q{A convore.com API implementation in ruby using EM}
+
+  # s.rubyforge_project = "convore"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency('eventmachine','0.12.10')
+  s.add_dependency('rest-client','1.6.7')
+  s.add_dependency('em-http-request','0.3.0')
+end

data/lib/convore.rb

@@ -0,0 +1,18 @@
+require 'net/http'
+require 'json'
+require 'eventmachine'
+require 'em-http-request'
+
+module Convore
+end
+
+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/api.rb

@@ -0,0 +1,22 @@
+# TODO: Establish link to client connect, to use their username/password?
+
+module Convore
+	class API
+		class << self
+			def cache
+				@@cache ||= {}
+			end
+
+			def get(api_uri, username=nil, password=nil)
+				response = cache[api_uri] ? cache[api_uri] : 
+				Net::HTTP.start('convore.com', 443, nil, nil, nil, nil, {:use_ssl => true}) {|http|
+					req = Net::HTTP::Get.new(api_uri)
+					req.basic_auth(username, password) if username && password
+					req.set_content_type('application/json')
+					http.request(req)
+				}
+				cache[api_uri] = response
+			end
+		end
+	end
+end

data/lib/convore/base.rb

@@ -0,0 +1,69 @@
+module Convore
+	class Base
+		attr_accessor :attributes, :username, :password
+
+		def initialize
+			@attributes ||= {}
+		end
+
+		
+		def method_missing(method, *args)
+      @attributes = {} if @attributes.nil?
+			if method.match(/\=/)
+				@attributes[method.to_s.gsub(/\=$/, '').to_sym] = args.first
+				return true
+			else
+				return @attributes[method] if @attributes[method]
+			end
+			raise NoMethodError.new("no such method: #{method}")
+		end
+		
+
+		class << self
+
+			def get_class(key)
+				case key
+				when 'message' then	Message
+				when 'user', 'creator', 'mentioned_user' then User
+				when 'group' then Group
+				when 'topic' then Topic
+				end
+			end
+
+			def from_json(json)
+				return nil if !json
+
+				object = new(@username, @password)
+				json.each {|key, val|
+					key_class = get_class(key)
+
+					value = if val.is_a?(Hash) && key_class
+						key_class.from_json(json[key])
+					elsif val.is_a?(Numeric) && key_class && key_class.api
+						key_class.find(val)
+					else
+						val
+					end
+
+					object.send("#{key}=", value)
+				}
+				object
+			end
+			
+			def api
+				nil
+			end
+			
+			def find(rid)
+				return false if !api || !rid.is_a?(Numeric)
+
+				api_uri = "/api/#{api[-1] == 's' ? api : "#{api}s"}/#{rid}.json"
+
+				response = Convore::API.get(api_uri)
+				
+				json = JSON.parse(response.body)
+				from_json(json[api])
+			end
+		end
+	end
+end

data/lib/convore/client.rb

@@ -0,0 +1,47 @@
+require 'yaml'
+module Convore
+	class Client
+		attr_accessor :thread, :stream, :cursor, :username, :password
+
+		def initialize
+			@stream ||= []
+			@ts ||= Time.now.to_f
+		end
+		
+		def listen
+			raise Exception.new("username and password need to be set to listen to /live") if !username || !password
+
+      http = EM::HttpRequest.new("https://convore.com/api/live.json?cursor=#{@cursor if @cursor}").get :head => {'authorization' => ["#{@username}", "#{@password}"]}
+
+      http.callback {
+        process_response(http.response)
+      }
+
+      http.errback  {
+      }
+
+		end
+
+		def process_response(response)
+			json = JSON.parse(response)
+
+			if json['messages']
+				json['messages'].each {|msg|
+					if msg['_ts'] && @ts < msg['_ts']
+						case msg['kind']
+						when 'message' then
+							stream.unshift(Message.from_json(msg))
+						when 'topic' then
+							stream.unshift(Topic.from_json(msg))
+						when 'star', 'unstar' then
+							stream.unshift(Star.from_json(msg))
+						end
+						@ts = msg['_ts'] if msg['_ts']
+						@cursor = msg['_id'] if msg['_id']
+					end
+				}
+			end
+		end
+		
+	end
+end

data/lib/convore/group.rb

@@ -0,0 +1,102 @@
+#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
+	end
+end

data/lib/convore/message.rb

@@ -0,0 +1,25 @@
+module Convore
+	class Message < Base
+		
+		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

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

data/lib/convore/user.rb

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

@@ -0,0 +1,3 @@
+module Convore
+	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

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification 
+name: em-convore
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Carlos Vilhena
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-26 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: eventmachine
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 59
+        segments: 
+        - 0
+        - 12
+        - 10
+        version: 0.12.10
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 6
+        - 7
+        version: 1.6.7
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: em-http-request
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 0
+        - 3
+        - 0
+        version: 0.3.0
+  type: :runtime
+  version_requirements: *id003
+description: A convore.com API implementation in ruby using EM
+email: 
+- carlosvilhena@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- 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/message.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
+homepage: http://carvil.github.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: A convore.com API implementation in ruby using EM
+test_files: 
+- test/test_account.rb
+- test/test_group.rb
+- test/test_message.rb
+- test/test_topic.rb
+- test/test_user.rb