socialcastr 0.0.1 → 0.1.0

data/spec/message_spec.rb

@@ -0,0 +1,173 @@
+require 'spec_helper'
+
+describe Socialcastr::Message do
+  context "fetching a specific message from socialcast" do
+    before :all do
+      fake_socialcast_api_for(:message) do
+        @message = Socialcastr::Message.find(425)
+      end
+    end 
+
+    it "should return a Message object" do
+      @message.class.should == Socialcastr::Message
+     end
+
+    it "should have a proper title" do
+      @message.title.should == "trying out the api"
+    end
+
+    it "should have an id" do
+      @message.id.should_not be_nil
+      @message.id.should == 425
+    end
+    it "should have a body" do
+      @message.body.should_not be_nil
+    end
+
+    it "should have a user" do
+      @message.user.should_not be_nil
+      @message.user.class.should == Socialcastr::User
+    end
+
+    it "should have a collection of groups" do
+      @message.groups.class.should == Array
+    end
+
+    it "should belong to a well formed group" do
+      @message.groups.first.class.should == Socialcastr::Group
+    end
+
+    it "should have a source" do
+      @message.source.should_not be_nil
+      @message.source.class.should == Socialcastr::Source
+    end
+
+  end
+
+  context "fetching a page's worth of messages" do
+    before :each do
+      fake_socialcast_api_for(:messages) do
+        @messages = Socialcastr::Message.all
+      end
+    end
+
+    it "should be an instance of MessageList" do
+      @messages.class.should == MessageList
+    end
+
+    it "should be a collection of 20 Socialcastr::Message objects" do
+      @messages.size.should == 20
+    end
+
+    it "should be possible to fetch the first item" do
+      @messages.first.should_not be_nil
+      @messages.first.class.should == Socialcastr::Message
+    end
+
+    it "should contain well formed Message objects" do
+      @messages.first.title.should == "trying out the api"
+    end 
+  end
+
+  context 'flagging a message' do
+    before :each do
+      fake_socialcast_api_for(:message) do 
+        @message = Socialcastr::Message.find(425)
+      end
+      @api = mock(:api)
+      response = "<flag><id>3333</id></flag>"
+      Socialcastr::Message.stub!(:api).and_return(@api)
+      @api.stub!(:post).and_return(response)
+    end
+
+    it "should assign an id to the Flag" do
+      @message.flag!
+      @message.flag.id.should == 3333
+    end
+
+    context "unflagging the message" do
+      before :each do
+        @message.flag!
+        @api.should_receive(:delete).with("/messages/425/flags/3333").and_return("")
+      end
+
+      it "should not have a flag afterwards" do
+        @message.unflag!
+        @message.flag.id.should be_nil
+      end
+    end
+  end
+
+  context 'liking a message' do
+    before :each do
+      fake_socialcast_api_for :message do 
+        @message = Socialcastr::Message.find(425)
+      end
+
+      @api = mock(:api)
+      response = "<like><id>2222</id><unlikable>true</unlikable></like>"
+      Socialcastr::Message.stub!(:api).and_return(@api)
+      @api.stub!(:post).and_return(response)
+    end
+
+    it 'should create a new like' do
+      old_count = @message.likes.count
+      @message.like!
+      @message.likes.count.should == old_count + 1
+    end
+
+    it 'should assign an id the the new like' do
+      @message.like!
+      @message.likes.last.id.should == 2222
+    end
+  end
+
+  context "unliking a message" do
+    before :each do 
+      fake_socialcast_api_for :message do 
+        @message = Socialcastr::Message.find(425)
+      end
+
+      @api = mock(:api)
+      response = "<like><id>2222</id><unlikable>true</unlikable></like>"
+      Socialcastr::Message.stub!(:api).and_return(@api)
+      @api.stub!(:post).and_return(response)
+      @api.stub!(:delete).and_return("")
+      @message.like!
+    end
+
+    it "should remove a like" do
+      old_count = @message.likes.count
+      @message.unlike!
+      @message.likes.count.should == old_count -1
+    end
+  end
+
+  context "searching for messages matching 'trying'" do
+    before :each do
+      fake_socialcast_api_for :message
+    end
+
+    it "should return a message" do
+      @messages = Socialcastr::Message.search(:q=>"trying")
+      @messages.size.should == 1
+    end
+  end
+
+  context "commenting a message" do
+    before :each do
+      fake_socialcast_api_for :message do
+        @message = Socialcastr::Message.find(425)
+      end
+    end
+
+    it "should post to messages/425/comments.xml" do
+      @api = mock(:api)
+      response = "<comment></comment>"
+      Socialcastr::Message.stub!(:api).and_return(@api)
+      @api.should_receive(:post).with("/messages/425/comments", {:text => "hallo world"}).and_return(response)
+      @message.comment! :text => "hallo world"
+    end
+     
+  end
+end

data/spec/socialcastr_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe Socialcastr do
+  context 'configuration' do
+    context 'called without a block' do
+      before :each do
+        @config = Socialcastr.configuration
+      end
+      it 'should return a Socialcastr::Configuration instance' do
+        @config.class.should == Socialcastr::Configuration
+      end
+    end
+    context 'called with a block' do
+      before :each do
+        @called = nil
+        Socialcastr.configuration do |config|
+          @called = config
+        end
+      end
+      it 'should call the block' do
+        @called.should_not be_nil
+      end
+      it 'should pass a configuration instance to the block' do
+        @called.equal?(Socialcastr::Configuration.instance).should be_true
+      end
+      context 'pointing to a yaml ile' do
+        before :each do
+          Socialcastr.configuration do |config|
+            config.config_file = File.join(File.dirname(__FILE__), 'fixtures', 'demo_config.yml')
+          end
+        end
+
+        it 'should load the configuration attributes from the file' do
+          Socialcastr.configuration.username.should == "file_demo"
+          Socialcastr.configuration.password.should == "password"
+          Socialcastr.configuration.domain.should == "demo.socialcast.com"
+        end
+      end
+    end
+  end
+
+  context 'api' do
+    context 'called without having configured Socialcastr' do
+      it 'should raise an error' do
+        lambda { Socialcastr.api }.should raise_error
+      end
+    end
+    context 'called after configuring Socialcastr' do
+      before :each do
+        configure_socialcastr
+        @api = Socialcastr.api
+      end
+      it 'should return a new Socialcastr::API instance' do
+        @api.class.should == Socialcastr::API
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,54 @@
+require "rubygems"
+require "bundler"
+Bundler.setup
+
+require 'rspec'
+require 'artifice'
+
+$: << File.join(File.dirname(__FILE__), '..', 'lib')
+require 'socialcastr'
+
+RSpec.configure do |config|
+  config.before :each do 
+    Socialcastr.configuration.reset
+  end
+end
+def generate_fake_endpoint(response, code=200)
+  return proc { |env|
+    [code, {"Content-Type"  => "text/html",
+           "X-Test-Method" => env["REQUEST_METHOD"],
+           "X-Test-Input"  => env["rack.input"].read,
+           "X-Test-Scheme" => env["rack.url_scheme"],
+           "X-Test-Host"   => env["HTTP_HOST"] || env["SERVER_NAME"],
+           "X-Test-Port"   => env["SERVER_PORT"]},
+      [response]
+    ]
+  }
+end
+
+def configure_socialcastr
+    Socialcastr.configuration do |c|
+      c.username = "demo"
+      c.password = "password"
+      c.domain   = "demo.socialcast.com"
+    end
+end
+
+def fake_socialcast_api_for(type, &block)
+  configure_socialcastr
+  case type
+  when :message
+    responsefile = "message.xml"
+  when :messages
+    responsefile = "messages.xml"
+  end
+  response = File.read(File.join(File.dirname(__FILE__), 'fixtures', responsefile))
+  endpoint = generate_fake_endpoint(response)
+  if block
+    Artifice.activate_with(generate_fake_endpoint(response)) do
+      block.call
+    end
+  else
+    Artifice.activate_with(generate_fake_endpoint(response))
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: socialcastr
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Riccardo Cambiassi
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-12 00:00:00 +01:00
+date: 2011-05-10 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -49,7 +49,7 @@ dependencies:
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: sax-machine
+  name: yard
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
@@ -60,8 +60,36 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :runtime
+  type: :development
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: artifice
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: sax-machine
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id005
 description: A Ruby wrapper for the Socialcast REST API
 email: 
 - bru@codewitch.org
@@ -77,37 +105,43 @@ files:
 - LICENSE.markdown
 - README.markdown
 - Rakefile
+- examples/parse_messages.rb
+- examples/post_comment.rb
+- examples/post_message.rb
+- examples/search.rb
 - 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/collection.rb
 - lib/socialcastr/comment.rb
-- lib/socialcastr/comment_list.rb
+- lib/socialcastr/exceptions.rb
 - lib/socialcastr/external_resource.rb
-- lib/socialcastr/external_resource_list.rb
+- lib/socialcastr/flag.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
+- spec/api_spec.rb
+- spec/base_spec.rb
+- spec/comment_spec.rb
+- spec/configuration_spec.rb
+- spec/fixtures/demo_config.yml
+- spec/fixtures/message.xml
+- spec/fixtures/messages.xml
+- spec/message_spec.rb
+- spec/socialcastr_spec.rb
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: https://github.com/bru/socialcastr
 licenses: []
@@ -153,5 +187,14 @@ rubygems_version: 1.5.3
 signing_key: 
 specification_version: 3
 summary: Ruby wrapper for the Socialcast API
-test_files: []
-
+test_files: 
+- spec/api_spec.rb
+- spec/base_spec.rb
+- spec/comment_spec.rb
+- spec/configuration_spec.rb
+- spec/fixtures/demo_config.yml
+- spec/fixtures/message.xml
+- spec/fixtures/messages.xml
+- spec/message_spec.rb
+- spec/socialcastr_spec.rb
+- spec/spec_helper.rb

data/lib/socialcastr/attachment_list.rb

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

data/lib/socialcastr/comment_list.rb

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

data/lib/socialcastr/external_resource_list.rb

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

data/lib/socialcastr/group_list.rb

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

data/lib/socialcastr/group_membership_list.rb

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

data/lib/socialcastr/like_list.rb

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

data/lib/socialcastr/media_file_list.rb

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

data/lib/socialcastr/message_list.rb

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

data/lib/socialcastr/recipient_list.rb

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

data/lib/socialcastr/stream_list.rb

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

data/lib/socialcastr/tag_list.rb

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