socialcastr 0.0.1 → 0.1.0

data/lib/socialcastr/message.rb

@@ -1,6 +1,7 @@
 module Socialcastr
   class Message < Base
 
+    id_element :id
     element :title
     element :body
     element :url
@@ -8,7 +9,6 @@ module Socialcastr
     element :action
     element :external_url
     element :icon
-    element :id
     element :likable
     element :created_at
     element :updated_at
@@ -17,8 +17,8 @@ module Socialcastr
     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 :group, :class => Socialcastr::Group
+    elements :group, :as => :groups, :class => Socialcastr::Group
     element :source, :class => Socialcastr::Source
 
     element :editable
@@ -26,7 +26,7 @@ module Socialcastr
     element :category_id
     element :subscribed
     # element :ratings_average
-    element :flag
+    element :flag, :class => Socialcastr::Flag
     element :deletable
     element :comments_count
     element :verb
@@ -36,17 +36,51 @@ module Socialcastr
     # element :target_user
     element :ratable
     element :message_type
-    element :recipients, :as => :recipient_list, :class => Socialcastr::RecipientList
+    elements :recipient, :as => :recipients, :class => Socialcastr::Recipient
 
-    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
+    elements :attachment, :as => :attachments, :class => Socialcastr::Attachment
+    elements :tag, :as => :tags, :class => Socialcastr::Tag
+    elements :like, :as => :likes, :class => Socialcastr::Like
+    elements :external_resource, :as => :external_resources, :class => Socialcastr::ExternalResource
+    elements :media_files, :as => :media_file, :class => Socialcastr::MediaFile
     element :likes_count
     element :hidden
 
-    element :comments, :as => :comment_list, :class => Socialcastr::CommentList
+    elements :comment, :as => :comments, :class => Socialcastr::Comment
 
+    def flag!
+      return true if flagged?
+      flag.copy_attributes_from_object(Flag.parse(api.post(element_path + "/flags")))
+    end
+
+    def flagged?
+      !flag.id.nil?
+    end
+
+    def unflag!
+      return unless flagged?
+      api.delete(element_path + "/flags/#{flag.id}")
+      @flag = Flag.new
+    end
+
+    def like!
+      likes << Like.parse(api.post(element_path + "/likes"))
+    end
+
+    def unlike!
+      likes.reject! do |l|
+        l.unlikable && api.delete(element_path + "/likes/#{l.id}")
+      end
+    end
+
+    def comment!(arguments={})
+      comment = Socialcastr::Comment.new(arguments)
+      api.post(element_path + "/comments", comment.to_params)
+    end
+    
+
+    def self.search(arguments={})
+      parse_collection(api.get(collection_path + "/search", arguments))
+    end
   end
 end

data/lib/socialcastr/version.rb

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

data/lib/socialcastr.rb

@@ -1,41 +1,48 @@
 $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__))) unless $LOAD_PATH.include?(File.expand_path(File.dirname(__FILE__)))
 
+require 'socialcastr/exceptions'
 require 'socialcastr/base'
+require 'socialcastr/collection'
 require 'socialcastr/api'
 require 'socialcastr/attachment'
-require 'socialcastr/attachment_list'
 require 'socialcastr/avatar_list'
 require 'socialcastr/user'
+require 'socialcastr/flag'
 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'
+require 'yaml'
 
 module Socialcastr
+
+  class MissingConfiguration < StandardError; end;
+
   class Configuration
     include Singleton
     ATTRIBUTES = [:domain, :username, :password, :config_file]
     attr_accessor *ATTRIBUTES
+
+    def ready?
+      [@domain, @username, @password].map(&:nil?).none?
+    end
+
+    def reset
+      ATTRIBUTES.each do |attribute|
+        send(attribute.to_s + "=", nil)
+      end
+      return self
+    end
   end 
 
   def self.configuration
@@ -53,6 +60,7 @@ module Socialcastr
 
   def self.api
     config = Configuration.instance
+    raise MissingConfiguration unless config.username
     API.new(config.username, config.password, config.domain)
   end
   

data/socialcastr.gemspec

@@ -4,6 +4,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_development_dependency('yard')
+  s.add_development_dependency('artifice')
   s.add_runtime_dependency('sax-machine')
   s.authors = ["Riccardo Cambiassi"]
   s.description = %q{A Ruby wrapper for the Socialcast REST API}

data/spec/api_spec.rb

@@ -0,0 +1,167 @@
+require 'spec_helper'
+
+describe Socialcastr::API do
+  before :each do
+    @api = Socialcastr::API.new("demo", "password", "demo.socialcast.com")
+  end
+
+  context "trying to use an invalid HTTP method" do
+    it "should raise an InvalidMethod exception" do
+      lambda {@api.https_request(:wrong, nil, nil)}.should raise_error(Socialcastr::InvalidMethod)
+    end
+  end
+  context "trying to access a non existing resource" do
+    it "should throw a ResourceNotFound exception" do
+      Artifice.activate_with(generate_fake_endpoint("", 404)) do
+        lambda { @api.get :messages }.should raise_error(Socialcastr::ResourceNotFound)
+      end 
+    end
+  end
+  context "being redirected" do
+    it "should throw a Redirection exception" do
+      Artifice.activate_with(generate_fake_endpoint("", 301)) do
+        lambda { @api.get :messages }.should raise_error(Socialcastr::Redirection)
+      end
+    end
+  end
+  context "receiving a bad request response" do
+    it "should throw a BadRequest exception" do
+      Artifice.activate_with(generate_fake_endpoint("", 400)) do
+        lambda { @api.get :messages }.should raise_error(Socialcastr::BadRequest)
+      end
+    end
+  end
+  context "receiving a unauthorized access response" do
+    it "should throw a Unauthorized exception" do
+      Artifice.activate_with(generate_fake_endpoint("", 401)) do
+        lambda { @api.get :messages }.should raise_error(Socialcastr::UnauthorizedAccess)
+      end
+    end
+  end
+  context "receiving a forbidden access response" do
+    it "should throw a ForbiddenAccess xception" do
+      Artifice.activate_with(generate_fake_endpoint("", 403)) do
+        lambda { @api.get :messages }.should raise_error(Socialcastr::ForbiddenAccess)
+      end
+    end
+  end
+  context "receiving a method not allowed response" do
+    it "should throw a MethodNotAllowed exception" do
+      Artifice.activate_with(generate_fake_endpoint("", 405)) do
+        lambda { @api.get :messages }.should raise_error(Socialcastr::MethodNotAllowed)
+      end
+    end
+  end
+  context "receiving a resource conflict response" do
+    it "should throw a ResourceConflict exception" do
+      Artifice.activate_with(generate_fake_endpoint("", 409)) do
+        lambda { @api.get :messages }.should raise_error(Socialcastr::ResourceConflict)
+      end
+    end
+  end
+  context "receiving a resource gone response" do
+    it "should throw a ResourceGone exception" do
+      Artifice.activate_with(generate_fake_endpoint("", 410)) do
+        lambda { @api.get :messages }.should raise_error(Socialcastr::ResourceGone)
+      end
+    end
+  end
+  context "receiving a resource invalid response" do
+    it "should throw a ResourceInvalid exception" do
+      Artifice.activate_with(generate_fake_endpoint("", 422)) do
+        lambda { @api.get :messages }.should raise_error(Socialcastr::ResourceInvalid)
+      end
+    end
+  end
+  context "receiving a server error response" do
+    it "should throw a ServerError exception" do
+      Artifice.activate_with(generate_fake_endpoint("", 500)) do
+        lambda { @api.get :messages }.should raise_error(Socialcastr::ServerError)
+      end
+    end
+  end
+  context "#get" do
+    it "should call Net::HTTP::Get" do
+      req = Net::HTTP::Get.new("/")
+      Net::HTTP::Get.should_receive(:new).and_return(req)
+      @messages = nil
+      fake_socialcast_api_for :message do
+        @messages = @api.get :message
+      end
+    end
+
+    it "should return an xml string" do
+      fake_socialcast_api_for :message do
+        @messages = @api.get :message
+      end
+
+      @messages.should_not be_nil
+      @messages.class.should == String
+    end
+  end
+
+  context "#put" do
+    it "should call Net::HTTP::Get" do
+      req = Net::HTTP::Put.new("/")
+      Net::HTTP::Put.should_receive(:new).and_return(req)
+      @messages = nil
+      fake_socialcast_api_for :message do
+        @messages = @api.put :message
+      end
+    end
+  end
+
+  context "#post" do
+    it "should call Net::HTTP::Get" do
+      req = Net::HTTP::Post.new("/")
+      Net::HTTP::Post.should_receive(:new).and_return(req)
+      @messages = nil
+      fake_socialcast_api_for :message do
+        @messages = @api.post :message
+      end
+    end
+  end
+
+  context "#delete" do
+    it "should call Net::HTTP::Get" do
+      req = Net::HTTP::Delete.new("/")
+      Net::HTTP::Delete.should_receive(:new).and_return(req)
+      @messages = nil
+      fake_socialcast_api_for :message do
+        @messages = @api.delete :message
+      end
+    end
+  end
+
+  context "#setup_https" do
+    before :each do
+      @https = @api.setup_https
+    end
+
+    it "should return an instance of Net::HTTP" do
+      @https.class.should == Net::HTTP
+    end
+    it "should use ssl" do
+      @https.use_ssl.should be_true
+    end
+    it "should not verify SSL" do
+      @https.verify_mode.should == OpenSSL::SSL::VERIFY_NONE
+    end
+
+  end
+
+  context "#build_query_string" do
+    it "should return a string" do
+      @api.build_query_string("").class.should == String
+    end
+    it "should prepend /api/ to the path" do
+      @api.build_query_string("test").should match(/^\/api\/test/)
+    end
+    it "should append the format to the path" do
+      @api.build_query_string("test").should match(/test\.xml$/)
+    end
+    it "should append a well formed query string when passing a parameters hash" do
+      @api.build_query_string("test", :hallo => "world").should match(/\?hallo=world$/)
+    end
+  end
+end

data/spec/base_spec.rb

@@ -0,0 +1,235 @@
+require 'spec_helper'
+
+describe Socialcastr::Base do
+  context 'api' do
+    context 'when Socialcastr has not been configured' do
+      it 'should raise an exception' do
+        lambda { Socialcastr::Base.api }.should raise_error
+      end
+    end
+    context 'when Socialcastr has been configured' do
+      before :each do
+        configure_socialcastr
+      end
+      it "should return the instance of Socialcastr::API" do
+        Socialcastr::Base.api.class.should == Socialcastr::API
+      end
+    end
+  end
+
+  context 'creating a new object with new()' do
+    it 'should return a new instance' do
+      class Post < Socialcastr::Base; end
+      post = Post.new
+      post.should_not be_nil
+      post.class.should == Post
+    end
+    
+    context 'for a class that has an element \'author\'' do
+      before :each do
+        class Post < Socialcastr::Base
+          element 'author'
+        end
+        @post = Post.new
+      end
+
+      it 'should be possible to access the author attribute' do
+        lambda { @post.author }.should_not raise_error
+      end
+
+      it 'should not initialize the author attribute' do
+        @post.author.should be_nil
+      end
+    end
+  end
+
+  context 'initializing a new object with author="john doe"' do
+    before :each do
+      class Post < Socialcastr::Base
+        id_element :id
+        element 'author'
+      end
+      @post = Post.new(:author => "john doe")
+    end
+
+    context '#author' do
+      it 'should return "john doe"' do
+        @post.author.should == "john doe"
+      end
+    end
+
+    context '#new?' do
+      it 'should return true' do
+        @post.new?.should be_true
+      end
+    end
+
+    context '#id' do
+      it 'should be nil' do
+        @post.id.should be_nil
+      end
+    end
+
+    context '#to_params' do
+      it 'should return a Hash ' do
+        @post.to_params.class.should == Hash
+      end
+    end
+
+    context '#param_name' do
+      it 'should return a string like model_name[variable_name]' do
+        @post.param_name("@author").should == "post[author]"
+      end
+    end
+
+    context "#copy_attributes_from_object" do
+      it "should copy the instance variables of on another object's to the current one" do
+        @another_post = Post.new(:author => "jane doe")
+        @post.copy_attributes_from_object(@another_post)
+        @post.author.should == "jane doe"
+      end
+    end
+
+    context 'saving it with #save' do
+      before :each do 
+        @api = mock('api', :post => "")
+        Socialcastr.stub!(:api).and_return(@api)
+      end
+      it 'should POST to the socialcast api' do
+        response = "<post><id>4</id><author>john doe</author></post>"
+        @api.should_receive(:post).and_return(response)
+        @post.save
+        @post.id.should == 4
+      end
+
+    end
+  end
+
+  context 'find_single or find(id)' do
+    before :each do
+      fake_socialcast_api_for(:message) do
+        @message = Socialcastr::Message.find(425)
+      end
+    end
+
+    it 'should return a Socialcastr::Base object' do
+      @message.class.should == Socialcastr::Message
+    end
+
+    it 'should not be new' do
+      @message.new?.should be_false
+    end
+
+    context 'after modifying one attribute' do
+      before :each do
+        @message.title = 'new title'
+      end
+
+      it 'the attribute should be changed' do
+        @message.title.should == "new title"
+      end
+
+      context 'saving the object with #save' do
+        it 'should PUT to the Socialcast API' do
+          @api = mock('api', :post => "")
+          Socialcastr::Message.stub!(:api).and_return(@api)
+          response = "<message></message>"
+          @api.should_receive(:put).and_return(response)
+          @message.save
+        end 
+      end
+    end
+  end
+
+  context 'find_every or find(:all)' do
+    before :each do
+      fake_socialcast_api_for(:message) do
+        @messages = Socialcastr::Base.find(:all)
+      end
+    end
+
+    it 'should return an enumerable' do
+      @messages.class.should == BaseList
+      lambda { @messages.first }.should_not raise_error
+    end
+  end
+  context 'first or find(:first)' do
+    before :each do
+      fake_socialcast_api_for(:message) do
+        @message = Socialcastr::Message.first
+      end
+    end
+
+    it 'should return an object' do
+      @message.class.should == Socialcastr::Message
+    end
+  end
+
+  context 'last or find(:last)' do
+    before :each do
+      fake_socialcast_api_for(:message) do
+        @message = Socialcastr::Message.last
+      end
+    end
+
+    it 'should return an object' do
+      @message.class.should == Socialcastr::Message
+    end
+  end
+
+  context 'model_name' do
+    it 'should return a lowercase string containing the object\'s classname' do
+      class Tree < Socialcastr::Base; end
+      Tree.model_name.should == 'Tree'
+    end
+
+    it 'should not include any module or prefix' do
+      class Socialcastr::Tree < Socialcastr::Base; end
+      Socialcastr::Tree.model_name.should == 'Tree'
+    end
+  end
+
+  context 'prefix' do
+    context 'being passed {:post_id => 3} as arguments' do
+      it 'should return posts/3/' do
+        Socialcastr::Base.prefix(:post_id => 3).should == 'posts/3/'
+      end
+    end
+  end
+
+  context 'collection_name' do
+    it 'should return a pluralized and downcase string' do
+      Socialcastr::Base.collection_name.should == 'bases'
+    end
+  end
+
+  context 'collection_class' do
+    before do
+      class Post < Socialcastr::Base; end
+    end
+    it 'should return a class' do
+      Post.collection_class.class.should == Class
+    end
+
+    it 'should return a class that inherits from Socialcastr::Collection' do
+      Post.collection_class.superclass.should == Socialcastr::Collection
+    end
+  end
+
+  context 'element_path' do
+    context 'with 5 as an argument' do
+      it 'should return collection_name/5' do
+        class Post < Socialcastr::Base; end
+        Post.element_path(5).should == '/posts/5'
+      end
+    end
+  end
+
+  context 'collection_path' do
+    it 'should return collection_name' do
+      class Post < Socialcastr::Base; end
+      Post.collection_path.should == '/posts'
+    end
+  end
+
+end

data/spec/comment_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe Socialcastr::Comment do
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,97 @@
+require 'spec_helper'
+
+describe Socialcastr::Configuration do
+
+  it 'should be a singleton' do
+    lambda {Socialcastr::Configuration.new }.should raise_error
+
+    config1 = Socialcastr::Configuration.instance
+    config2 = Socialcastr::Configuration.instance
+    config1.equal?(config2).should be_true
+  end
+
+  context 'when called for the first time' do
+    before :each do
+      @config = Socialcastr::Configuration.instance
+    end
+    it 'should not set a username' do
+      @config.username.should be_nil
+    end
+
+    it 'should not set a password' do
+      @config.password.should be_nil
+    end
+
+    it 'should not set a domain' do
+      @config.domain.should be_nil
+    end
+
+    it 'should not be ready' do
+      @config.ready?.should be_false
+    end
+
+    context 'then setting the username' do
+      before :each do
+        @config.username = "demo"
+      end
+
+      it 'should have a username' do
+        @config.username.should == "demo"
+      end
+    end
+
+    context 'then setting the password' do
+      before :each do
+        @config.password = "password"
+      end
+
+      it 'should have a username' do
+        @config.password.should == "password"
+      end
+    end
+
+    context 'then setting the domain' do
+      before :each do
+        @config.domain = "demo"
+      end
+
+      it 'should have a username' do
+        @config.domain.should == "demo"
+      end
+    end
+  end
+
+  context 'when properly configured' do
+    before do
+      @config = Socialcastr::Configuration.instance
+      @config.username = "demo"
+      @config.password = "password"
+      @config.domain   = "demo.socialcast.com"
+    end
+
+    it 'should be ready' do
+      @config.ready?.should be_true
+    end
+    context '#reset' do
+      before :each do
+        @config.reset
+      end
+
+      it 'should have no password' do
+        @config.password.should be_nil
+      end
+      it 'should have no username' do
+        @config.username.should be_nil
+      end
+
+      it 'should have no domain' do
+        @config.domain.should be_nil
+      end
+      it 'should not be ready' do
+        @config.ready?.should be_false
+      end
+    end
+
+  end
+
+end

data/spec/fixtures/demo_config.yml

@@ -0,0 +1,3 @@
+username: file_demo
+password: password
+domain:   demo.socialcast.com