socialcast-api 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 socialcast-api.gemspec
+gemspec

data/README

@@ -0,0 +1,43 @@
+First off I am not affiliated with Socialcast the company in any way.
+
+SocialcastAPI is a ruby interface to the RESTful API provided by Socialcast.com
+for interacting with their services as outlined here: 
+
+http://www.socialcast.com/resources/api.html
+
+Here I am implementing it using the ActiveResource library
+
+http://api.rubyonrails.org/classes/ActiveResource/Base.html
+
+which supports dynamically generating Ruby objects from the XML or JSON 
+structures returned from the calls to the web services.  At this point it is 
+mostly functional, I haven't really started playing with the attachments portion
+yet so don't expect that to work at the moment.  I need to add a lot of 
+documentation and examples though.  That's probably the next big thing to be 
+done.
+
+# Post a new message to your general purpose stream
+Message.new(:body => 'This was sent via the API')
+
+# Find the user named John Smith
+User.search(:q => 'john smith').first
+
+# List the top 10 users who have posted the most #worklogs
+users = Hash.new(0)
+
+Message.search_all_pages(:q => '#worklog').each do |message|
+  users[message.user.name] += 1
+end
+
+users.sort {|a,b| a[1] <=> b[1]}.reverse.first(10).each {|user| puts "#{user[0]}: #{user[1]}"}
+
+# Print count of all users in the community
+puts User.all_pages.count
+
+# Print all users name and url
+User.all_pages.each_with_index do |user, index|
+  puts "#{index}: #{user.name} - #{user.url}"
+end
+
+More examples to come.
+

data/Rakefile

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

data/lib/socialcast-api.rb

@@ -0,0 +1,26 @@
+require 'active_resource'
+require 'singleton'
+require 'yaml'
+
+module SocialcastApi
+  class Configuration
+    include Singleton
+    ATTRIBUTES = [:site, :user, :password, :config_file]
+    attr_accessor *ATTRIBUTES
+  end
+  
+  def self.configuration
+    if block_given?
+      yield Configuration.instance
+      if Configuration.config_file
+        config = YAML::load_file(Configuration.config_file)
+        Configuration.site = config['site']
+        Configuration.user = config['user']
+        Configuration.password = config['password']
+      end
+      require 'socialcast-api/base'
+    end
+    Configuration.instance
+  end
+
+end

data/lib/socialcast-api/base.rb

@@ -0,0 +1,150 @@
+module SocialcastApi
+  class Base < ActiveResource::Base
+    self.site = SocialcastApi.configuration.site
+    self.user = SocialcastApi.configuration.user
+    self.password = SocialcastApi.configuration.password
+  end
+
+  class Message < Base
+
+    class Like < Base
+      self.site = Message.site.to_s + "messages/:message_id/"
+    end
+
+    class Flag < Base
+      self.site = Message.site.to_s + "messages/:message_id/"
+    end
+
+    def self.search(args = {})
+      get(:search, args).map {|message| Message.new(message)}
+    end
+
+    def self.search_all_pages(args = {})
+      results = Array.new
+      page = 1
+      per_page = 500    
+  
+      begin
+        messages = get(:search, :page => page, :per_page => per_page, :q => args[:q]).map {|message| Message.new(message)}
+        page += 1
+        results += messages
+      end until messages.count < per_page
+
+      return results
+    end
+
+    def like
+      Message.post(id.to_s + '/likes')
+    end
+
+    def unlike
+      likedbyme = likes.select {|alike| alike.unlikable}.first
+      if likedbyme
+        likedbyme.prefix_options = {:message_id => self.id}
+        likedbyme.destroy 
+      end
+    end
+
+    def flag
+      Message.post(id.to_s + '/flags')
+    end
+
+    def unflag
+      Message.delete(id.to_s + '/flags/' + attributes[:flag].id)
+    end
+
+  end
+
+  class Comment < Base
+
+    self.site = Message.site.to_s + "messages/:message_id/"
+
+    class Like < Base
+      self.site = Comment.site.to_s + "comments/:comment_id/"
+    end
+
+    def like
+      Comment.post(id.to_s + '/likes')
+    end
+
+    def unlike
+      likedbyme = likes.select {|alike| alike.unlikable}.first
+      if likedbyme
+        likedbyme.prefix_options = {:message_id => message_id, :comment_id => self.id}
+        likedbyme.destroy 
+      end
+    end
+
+  end
+
+  class User < Base
+
+    def self.search(args = {})
+      get(:search, args).map {|user| User.new(user)}
+    end
+
+    def messages
+      get(:messages).map {|message| Message.new(message)}
+    end
+
+    def followers(args = {})
+      get(:followers, args).map {|follower| User.new(follower)}
+    end
+
+    def follow
+      User.post(id.to_s + '/followers')
+    end
+
+    def unfollow
+      delete('followers/' + contact_id.to_s)  
+    end
+
+    def following(args = {})
+      get(:following, args).map {|user| User.new(user)}
+    end
+
+    def self.all_pages
+      results = Array.new
+      page = 1
+      per_page = 500    
+  
+      begin
+        users = all(:params => {:page => page, :per_page => per_page})
+        page += 1
+        results += users
+      end until users.count < per_page
+
+      return results
+    end
+
+  end
+
+  class Stream < Base
+
+    def messages(args = {})
+      get(:messages, args).map {|message| Message.new(message)}
+    end
+
+  end
+
+  class Group < Base
+
+    def members(args = {})
+      get(:members, args).map {|member| User.new(member)}
+    end
+
+  end
+
+  class GroupMembership < Base
+  end
+
+  class Category < Base
+  end
+
+  class ContentFilter < Base
+  end
+
+  # This class is not working or tested yet, just a frame!
+  class Attachment < Base
+  end
+end

data/lib/socialcast-api/version.rb

@@ -0,0 +1,5 @@
+module Socialcast
+  module Api
+    VERSION = "0.0.1"
+  end
+end

data/socialcast-api.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "socialcast-api/version"
+
+Gem::Specification.new do |s|
+  s.name        = "socialcast-api"
+  s.version     = Socialcast::Api::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Matthew Closson", "Sean Cashin"]
+  s.email       = ["matthew.closson@gmail.com", "scashin133@gmail.com"]
+  s.homepage    = "http://github.com/mclosson/socialcast-api"
+  s.summary     = %q{Socialcast API Interface and Examples}
+  s.description = %q{Socialcast API Interface and Examples}
+
+  s.rubyforge_project = "scashin133-socialcast-api"
+  s.add_runtime_dependency(%q<activeresource>, [">= 2.3"])
+  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"]
+end

data/socialcast.yml

@@ -0,0 +1,3 @@
+user: your_email_address
+password: your_socialcast_password
+subdomain: your_socialcast_subdomain

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: socialcast-api
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Matthew Closson
+- Sean Cashin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-27 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activeresource
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        version: "2.3"
+  type: :runtime
+  version_requirements: *id001
+description: Socialcast API Interface and Examples
+email: 
+- matthew.closson@gmail.com
+- scashin133@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README
+- Rakefile
+- lib/socialcast-api.rb
+- lib/socialcast-api/base.rb
+- lib/socialcast-api/version.rb
+- socialcast-api.gemspec
+- socialcast.yml
+has_rdoc: true
+homepage: http://github.com/mclosson/socialcast-api
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: scashin133-socialcast-api
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Socialcast API Interface and Examples
+test_files: []
+