socialcastr 0.0.1

data/.gitignore

@@ -0,0 +1,11 @@
+*.gem
+*.rbc
+.DS_Store
+.bundle
+.rvmrc
+.yardoc
+Gemfile.lock
+coverage/*
+doc/*
+log/*
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+gemspec
+

data/LICENSE.markdown

@@ -0,0 +1,8 @@
+Copyright (c) 2011 Riccardo Cambiassi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/README.markdown

@@ -0,0 +1,45 @@
+# SocialCast
+
+SocialCast gem is a ruby interface to the SocialCast REST API
+
+## INSTALLATION
+
+    gem install socialcast4r
+
+## Usage
+
+    Socialcastr.configuration do |socialcast|
+      socialcast.username = "user@example.com"
+      socialcast.password = "password"
+      socialcast.domain   = "demo.socialcast.com"
+    end
+    
+    api = Socialcastr.api
+    
+    messages = api.messages
+    
+    message_params = { "message[title]" => "hallo world!", "message[body]" => "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."  }
+    reply = api.add_message(message_params)
+    message = Socialcastr::Message.parse(reply)
+
+
+## Status
+
+This is just the first draft of the wrapper. It can be improved in many, many ways.
+The API is not completely covered either: a lot of interesing stuff, like (un)liking and attachments have been left out. 
+Feel free to help (see Contributing below)
+
+## Contributing to the code (a.k.a. submitting a pull request)
+
+1. Fork the project.
+2. Create a topic branch.
+3. Implement your feature or bug fix.
+4. Commit and push your changes.
+5. Submit a pull request. Please do not include changes to the gemspec, version, or history file. (If you want to create your own version for some reason, please do so in a separate commit.)
+
+
+## Copyright
+
+Copyright (c) 2011 Riccardo Cambiassi. See LICENSE for details.
+
+

data/Rakefile

@@ -0,0 +1,24 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+task :default => :spec
+
+namespace :doc do
+  require 'yard'
+  YARD::Rake::YardocTask.new do |task|
+    task.files   = ['HISTORY.mkd', 'LICENSE.mkd', 'lib/**/*.rb']
+    task.options = [
+      '--protected',
+      '--output-dir', 'doc/yard',
+      '--tag', 'format:Supported formats',
+      '--tag', 'authenticated:Requires Authentication',
+      '--tag', 'rate_limited:Rate Limited',
+      '--markup', 'markdown',
+    ]
+  end
+end
+

data/lib/socialcastr/api.rb

@@ -0,0 +1,128 @@
+require 'net/http'
+require 'net/https'
+require 'openssl'
+require 'uri'
+require 'digest/md5'
+require 'cgi'
+
+
+
+module Socialcastr
+  class API
+    attr_accessor :debug
+    
+    def initialize(username, password, domain, format="xml",debug=false)
+      @debug    = debug
+      @username = username
+      @password = password
+      @format   = format
+      @endpoint = "https://#{domain}/api/"
+      return self
+    end
+    
+    def messages(stream=nil, query={})
+      method="messages"
+      method.insert(0, "streams/#{stream.id}/") if stream
+      xml = api_get(method, query)
+      return Socialcastr::MessageList.parse(xml).messages
+    end
+    
+    def search(query)
+      method="messages/search"
+      xml = api_get(method, query)
+      return Socialcastr::MessageList.parse(xml).messages
+    end
+    
+    def groups
+      method = "group_memberships"
+      xml = api_get(method)
+      return Socialcastr::GroupMembershipList.parse(xml).group_memberships
+    end
+    
+    def streams
+      method = "streams"
+      xml = api_get(method)
+      return Socialcastr::StreamList.parse(xml).streams
+    end
+    
+    def add_message(message)
+      xml = api_post("messages", message)
+      return xml
+    end
+    
+    def add_comment(message_id, comment)
+      xml = api_post("messages/#{message_id}/comments", comment)
+      return xml
+    end
+    
+    def like_comment(message_id,comment_id)
+      xml = api_post("messages/#{message_id.to_s}/comments/#{comment_id.to_s}/likes")
+      return xml
+    end
+    
+    def unlike_comment(message_id,comment_id,like_id)
+      xml = api_delete("messages/#{message_id}/comments/#{comment_id}/likes/#{like_id}")
+      return xml
+    end
+    
+    def https_request(method, path, args)
+      https = setup_https
+      response = ""
+      
+      # HACK
+      # if path == "messages/search"
+      #   path = "messages"
+      # end
+      # data = File.read(File.join('/tmp','fixtures','xml', "#{path}.#{@format}"))
+      # return data
+      # # /HACK
+
+      case method
+        when 'get'
+        request_class = Net::HTTP::Get
+        query=args
+        when 'post'
+        request_class = Net::HTTP::Post
+        form_data = args
+        when 'put'
+        request_class = Net::HTTP::Put
+        form_data = args
+        when 'delete'
+        request_class = Net::HTTP::Delete
+      end
+      https.start do |session|
+        query_string = "/api/#{path}.#{@format}"
+        query_string += "?" + (query.collect { |k,v| "#{k}=#{CGI::escape(v.to_s)}" }.join('&')) unless query.nil?
+        req = request_class.new(query_string)
+        req.basic_auth @username, @password
+        if form_data
+          req.set_form_data(args, ';')
+        end
+        response = session.request(req).body
+      end
+
+      response  
+    end
+    
+    def api_get(path, args={})
+      https_request('get', path, args)
+    end   
+    
+    
+    def api_post(path, args={})
+      https_request('post', path, args)
+    end
+    
+    def api_delete(path, args={})
+      https_request('delete', path, args)
+    end
+    
+    def setup_https
+      url   = URI.parse(@endpoint) 
+      https = Net::HTTP.new(url.host, url.port)
+      https.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      https.use_ssl = true
+      return https
+    end
+  end
+end

data/lib/socialcastr/attachment.rb

@@ -0,0 +1,10 @@
+module Socialcastr
+  class Attachment < Base
+    element :public_filename
+    element :content_type
+    element :url
+    element :file_extension
+    element :filename
+    element :id
+  end
+end

data/lib/socialcastr/attachment_list.rb

@@ -0,0 +1,5 @@
+module Socialcastr
+  class AttachmentList < Base
+    elements :attachment, :as => :attachments, :class => Attachment
+  end
+end

data/lib/socialcastr/avatar_list.rb

@@ -0,0 +1,9 @@
+module Socialcastr
+  class AvatarList < Base
+    element :square16
+    element :square30
+    element :square45
+    element :square70
+    element :square140
+  end
+end

data/lib/socialcastr/base.rb

@@ -0,0 +1,6 @@
+require 'sax-machine'
+module Socialcastr
+  class Base 
+    include SAXMachine 
+  end
+end

data/lib/socialcastr/comment.rb

@@ -0,0 +1,29 @@
+module Socialcastr
+  class Comment < Base
+    element :editable
+    element :attachments, :as => :attachment_list, :class => Socialcastr::AttachmentList
+    element :likable
+    element :deletable
+    element :likes, :as => :like_list, :class => Socialcastr::LikeList
+    element :permalink_url
+    element :text
+    element :user, :class => Socialcastr::User
+    element :thumbnail_url
+    element :url
+    element :likes_count
+    element :created_at
+    element :id
+
+    def unlikable_by?(api_id)
+      self.likes.map{|l| l.unlikable_by?(api_id)}.any?
+    end
+    
+    def likable_by?(api_id)
+      self.user_id  != api_id
+    end
+    
+    def like_id(api_id)
+      self.likes.select { |like| like.unlikable_by?(api_id) }.first.id
+    end
+  end
+end

data/lib/socialcastr/comment_list.rb

@@ -0,0 +1,5 @@
+module Socialcastr
+  class CommentList < Base
+    element :comment, :as => :comments, :class => Socialcastr::Comment
+  end
+end

data/lib/socialcastr/external_resource.rb

@@ -0,0 +1,14 @@
+module Socialcastr
+  class ExternalResource < Base
+    element :type
+    element :tags, :as => :tag_list, :class => Socialcastr::TagList
+    element :canonical_hashtag
+    element :source, :class => Socialcastr::Source
+    element :media_files, :as => :media_file_list, :class => Socialcastr::MediaFileList 
+    element :url
+    element :title
+    element :description
+    element :id
+    
+  end
+end

data/lib/socialcastr/external_resource_list.rb

@@ -0,0 +1,5 @@
+module Socialcastr
+  class ExternalResourceList < Base
+    elements :external_resource, :as => :external_resources, :class => ExternalResource
+  end
+end

data/lib/socialcastr/group.rb

@@ -0,0 +1,9 @@
+module Socialcastr
+  class Group < Base
+    element :url
+    element :id
+    element :name
+    element :avatars, :class => Socialcastr::AvatarList
+    
+  end
+end

data/lib/socialcastr/group_list.rb

@@ -0,0 +1,5 @@
+module Socialcastr
+  class GroupList < Base
+    elements :group, :as => :groups, :class => Socialcastr::Group
+  end
+end

data/lib/socialcastr/group_membership.rb

@@ -0,0 +1,6 @@
+module Socialcastr
+  class GroupMembership < Base
+    element :group, :class => Socialcastr::Group
+    element :role
+  end
+end

data/lib/socialcastr/group_membership_list.rb

@@ -0,0 +1,5 @@
+module Socialcastr
+  class GroupMembershipList < Base
+    elements :group_membership, :as => :group_memberships, :class => Socialcastr::GroupMembership
+  end
+end

data/lib/socialcastr/like.rb

@@ -0,0 +1,11 @@
+module Socialcastr
+  class Like < Base
+    element :unlikable
+    element :user, :class => Socialcastr::User
+    element :created_at
+    element :id
+    def unlikable_by?(api_id)
+      @unlikable && api_id == self.user_id ? true : false
+    end
+  end
+end

data/lib/socialcastr/like_list.rb

@@ -0,0 +1,5 @@
+module Socialcastr
+  class LikeList < Base
+    element :like, :as => :likes, :class => Socialcastr::Like
+  end
+end

data/lib/socialcastr/media_file.rb

@@ -0,0 +1,12 @@
+module Socialcastr
+  class MediaFile < Base
+    element :external_resource_id
+    element :page_url
+    element :attachment_id
+    element :content_type
+    element :url
+    element :thumbnails, :class => Socialcastr::ThumbnailList
+    element :title
+    element :description
+  end
+end

data/lib/socialcastr/media_file_list.rb

@@ -0,0 +1,5 @@
+module Socialcastr
+  class MediaFileList < Base
+    elements :media_file, :as => :media_files, :class => Socialcastr::MediaFile
+  end
+end

data/lib/socialcastr/message.rb

@@ -0,0 +1,52 @@
+module Socialcastr
+  class Message < Base
+
+    element :title
+    element :body
+    element :url
+    element :permalink_url
+    element :action
+    element :external_url
+    element :icon
+    element :id
+    element :likable
+    element :created_at
+    element :updated_at
+    element :last_interacted_at
+    element :player_url
+    element :thumbnail_url
+    element :player_params
+    element :user, :class => Socialcastr::User
+    element :group, :class => Socialcastr::Group
+    element :groups, :as => :group_list, :class => Socialcastr::GroupList
+    element :source, :class => Socialcastr::Source
+
+    element :editable
+    element :rating
+    element :category_id
+    element :subscribed
+    # element :ratings_average
+    element :flag
+    element :deletable
+    element :comments_count
+    element :verb
+    element :in_reply_to
+    element :watchable
+    element :contains_url_only
+    # element :target_user
+    element :ratable
+    element :message_type
+    element :recipients, :as => :recipient_list, :class => Socialcastr::RecipientList
+
+    element :attachments, :as => :attachment_list, :class => Socialcastr::AttachmentList
+    element :tags, :as => :tag_list, :class => Socialcastr::TagList
+    element :likes, :as => :like_list, :class => Socialcastr::LikeList
+    element :external_resources, :as => :external_resource_list, :class => Socialcastr::ExternalResourceList
+    element :media_files, :as => :media_file_list, :class => Socialcastr::MediaFileList
+    element :likes_count
+    element :hidden
+
+    element :comments, :as => :comment_list, :class => Socialcastr::CommentList
+
+  end
+end

data/lib/socialcastr/message_list.rb

@@ -0,0 +1,5 @@
+module Socialcastr
+  class MessageList < Base
+    elements :message, :as => :messages, :class => Message
+  end
+end

data/lib/socialcastr/recipient.rb

@@ -0,0 +1,11 @@
+module Socialcastr
+  class Recipient < Base
+    element :type
+    element :username
+    element :avatars, :class => Socialcastr::AvatarList
+    element :url 
+    element :name
+    element :id
+    element :private
+  end
+end

data/lib/socialcastr/recipient_list.rb

@@ -0,0 +1,6 @@
+module Socialcastr
+  class RecipientList < Base
+    elements :recipient, :as => :recipients, :class => Socialcastr::Recipient
+  end
+end
+

data/lib/socialcastr/source.rb

@@ -0,0 +1,8 @@
+module Socialcastr
+  class Source < Base
+    element :url
+    element :formal_name
+    element :name
+    element :id
+  end
+end

data/lib/socialcastr/stream.rb

@@ -0,0 +1,10 @@
+module Socialcastr
+  class Stream < Base
+    element :id
+    element :name
+    element :default
+    element :last_interacted_at
+    element :custom_stream
+    element :group, :class => Socialcastr::Group
+  end
+end

data/lib/socialcastr/stream_list.rb

@@ -0,0 +1,5 @@
+module Socialcastr
+  class StreamList < Base
+    elements :stream, :as => :streams, :class => Socialcastr::Stream
+  end
+end

data/lib/socialcastr/tag.rb

@@ -0,0 +1,5 @@
+module Socialcastr
+  class Tag < Base
+    element :name
+  end
+end

data/lib/socialcastr/tag_list.rb

@@ -0,0 +1,5 @@
+module Socialcastr
+  class TagList < Base
+    elements :tag, :as => :tags, :class => Socialcastr::Tag
+  end
+end

data/lib/socialcastr/thumbnail_list.rb

@@ -0,0 +1,8 @@
+module Socialcastr
+  class ThumbnailList < Base
+    element :square45
+    element :stream_square
+    element :scaled480
+    element :stream
+  end
+end

data/lib/socialcastr/user.rb

@@ -0,0 +1,11 @@
+module Socialcastr
+  class User < Base
+    element :type
+    element :terminated
+    element :username
+    element :avatars, :class => AvatarList
+    element :url
+    element :name
+    element :id
+  end
+end

data/lib/socialcastr/version.rb

@@ -0,0 +1,3 @@
+module Socialcastr
+  VERSION = "0.0.1"
+end

data/lib/socialcastr.rb

@@ -0,0 +1,59 @@
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__))) unless $LOAD_PATH.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'socialcastr/base'
+require 'socialcastr/api'
+require 'socialcastr/attachment'
+require 'socialcastr/attachment_list'
+require 'socialcastr/avatar_list'
+require 'socialcastr/user'
+require 'socialcastr/like'
+require 'socialcastr/like_list'
+require 'socialcastr/comment'
+require 'socialcastr/comment_list'
+require 'socialcastr/group'
+require 'socialcastr/group_list'
+require 'socialcastr/group_membership'
+require 'socialcastr/group_membership_list'
+require 'socialcastr/stream'
+require 'socialcastr/stream_list'
+require 'socialcastr/source'
+require 'socialcastr/tag'
+require 'socialcastr/tag_list'
+require 'socialcastr/recipient'
+require 'socialcastr/recipient_list'
+require 'socialcastr/thumbnail_list'
+require 'socialcastr/media_file'
+require 'socialcastr/media_file_list'
+require 'socialcastr/external_resource'
+require 'socialcastr/external_resource_list'
+require 'socialcastr/message'
+require 'socialcastr/message_list'
+
+require 'singleton'
+
+module Socialcastr
+  class Configuration
+    include Singleton
+    ATTRIBUTES = [:domain, :username, :password, :config_file]
+    attr_accessor *ATTRIBUTES
+  end 
+
+  def self.configuration
+    if block_given?
+      yield Configuration.instance
+      if Configuration.instance.config_file
+        config = YAML::load_file(Configuration.instance.config_file)
+        Configuration.instance.domain   = config['domain']
+        Configuration.instance.username = config['username']
+        Configuration.instance.password = config['password']
+      end 
+    end 
+    Configuration.instance
+  end 
+
+  def self.api
+    config = Configuration.instance
+    API.new(config.username, config.password, config.domain)
+  end
+  
+end

data/socialcastr.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/socialcastr/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.add_development_dependency('rake', '~> 0.8')
+  s.add_development_dependency('rspec', '~> 2.5')
+  s.add_runtime_dependency('sax-machine')
+  s.authors = ["Riccardo Cambiassi"]
+  s.description = %q{A Ruby wrapper for the Socialcast REST API}
+  s.post_install_message =<<eos
+********************************************************************************
+
+  Thank you for installing socialcastr
+
+  Follow @bru on Twitter for announcements, updates, and news.
+  https://twitter.com/bru
+
+********************************************************************************
+eos
+  s.email = ['bru@codewitch.org']
+  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.files = `git ls-files`.split("\n")
+  s.homepage = 'https://github.com/bru/socialcastr'
+  s.name = 'socialcastr'
+  s.platform = Gem::Platform::RUBY
+  s.require_paths = ['lib']
+  s.required_rubygems_version = Gem::Requirement.new('>= 1.3.6') if s.respond_to? :required_rubygems_version=
+  s.rubyforge_project = s.name
+  s.summary = %q{Ruby wrapper for the Socialcast API}
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.version = Socialcastr::VERSION.dup
+end
+

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification 
+name: socialcastr
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Riccardo Cambiassi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-12 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 0
+        - 8
+        version: "0.8"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 5
+        version: "2.5"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sax-machine
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: A Ruby wrapper for the Socialcast REST API
+email: 
+- bru@codewitch.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE.markdown
+- README.markdown
+- Rakefile
+- lib/socialcastr.rb
+- lib/socialcastr/api.rb
+- lib/socialcastr/attachment.rb
+- lib/socialcastr/attachment_list.rb
+- lib/socialcastr/avatar_list.rb
+- lib/socialcastr/base.rb
+- lib/socialcastr/comment.rb
+- lib/socialcastr/comment_list.rb
+- lib/socialcastr/external_resource.rb
+- lib/socialcastr/external_resource_list.rb
+- lib/socialcastr/group.rb
+- lib/socialcastr/group_list.rb
+- lib/socialcastr/group_membership.rb
+- lib/socialcastr/group_membership_list.rb
+- lib/socialcastr/like.rb
+- lib/socialcastr/like_list.rb
+- lib/socialcastr/media_file.rb
+- lib/socialcastr/media_file_list.rb
+- lib/socialcastr/message.rb
+- lib/socialcastr/message_list.rb
+- lib/socialcastr/recipient.rb
+- lib/socialcastr/recipient_list.rb
+- lib/socialcastr/source.rb
+- lib/socialcastr/stream.rb
+- lib/socialcastr/stream_list.rb
+- lib/socialcastr/tag.rb
+- lib/socialcastr/tag_list.rb
+- lib/socialcastr/thumbnail_list.rb
+- lib/socialcastr/user.rb
+- lib/socialcastr/version.rb
+- socialcastr.gemspec
+has_rdoc: true
+homepage: https://github.com/bru/socialcastr
+licenses: []
+
+post_install_message: |
+  ********************************************************************************
+  
+    Thank you for installing socialcastr
+  
+    Follow @bru on Twitter for announcements, updates, and news.
+    https://twitter.com/bru
+  
+  ********************************************************************************
+
+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: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: socialcastr
+rubygems_version: 1.5.3
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper for the Socialcast API
+test_files: []
+