slideshare 0.2.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+MIT-LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Saiku Desarrollos S.L.
+
+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.rdoc

@@ -0,0 +1,13 @@
+= slideshare
+
+A Ruby wrapper library for the SlideShare API
+
+== Requirements
+
+You will need to install HTTParty[http://github.com/jnunemaker/httparty/tree/master] and Curb[http://curb.rubyforge.org/] gems.
+
+== Caveats
+
+This gem is still in its infancy.
+
+copyright (c) 2009 Saiku Desarrollos S.L., released under the MIT license

data/Rakefile

@@ -0,0 +1,60 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "slideshare"
+    gem.summary = %Q{Ruby interface for SlideShare API}
+    gem.email = "pablo@saiku.es"
+    gem.homepage = "http://github.com/saiku/slideshare"
+    gem.authors = ["Saiku.es", "Russell Norris", "Andy Shen"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+    gem.add_dependency('httparty', '>= 0.4.3')
+    gem.add_dependency('curb', '>= 0.1.4')
+  end
+  
+  Jeweler::GemcutterTasks.new
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "slideshare #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/init.rb

@@ -0,0 +1 @@
+require "slide_share"

data/lib/slide_share/base.rb

@@ -0,0 +1,79 @@
+require "digest/sha1"
+
+module SlideShare
+  class Base
+    include HTTParty
+    base_uri "http://www.slideshare.net/api/2"
+    format :xml
+    
+    attr_accessor :api_key, :shared_secret
+    
+    # Returns an instance of <tt>SlideShare::Base</tt>. Takes the following options:
+    # 
+    # * <tt>:api_key</tt> - SlideShare API key
+    # * <tt>:shared_pass</tt> - SlideShared shared secret
+    # 
+    # Alternatively, this method may take the path to a YAML file containing
+    # this data. Examples (of both):
+    # 
+    #   # Using the options hash
+    #   @slideshare = SlideShare::Base.new(:api_key => "4815162342", :shared_secret => "dharma")
+    #   # Using the YAML file
+    #   @slideshare = SlideShare::Base.new("path/to/file.yml")
+    def initialize(hash_or_yaml)
+      config = hash_or_yaml.is_a?(Hash) ? hash_or_yaml :
+        YAML.load_file(hash_or_yaml)
+      self.api_key = config[:api_key]
+      self.shared_secret = config[:shared_secret]
+      unless api_key && shared_secret
+        raise ArgumentError, "Configuration must have values for :api_key and :shared_secret"
+      end
+    end
+    
+    # OO abstraction for <tt>SlideShare::Slideshow</tt> namespace. Example usage:
+    # 
+    #   @slideshare = SlideShare::Base.new("path/to/file.yml")
+    #   @slideshow = @slideshare.slideshows.find(815)
+    # 
+    # This is recommended over initializing and accessing a <tt>SlideShare::Slideshow</tt>
+    # object directly.
+    def slideshows
+      @slideshow ||= Slideshows.new(self)
+    end
+    
+  private
+    def get(*args)
+      catch_errors self.class.get(args.first,
+        {:query => add_required_params(args.extract_options!)})
+    end
+    
+    def post(*args)
+      options = add_required_params(args.extract_options!)
+      catch_errors self.class.post(args.first,
+        {:query => options})
+    end
+    
+    def add_required_params(options)
+      now = Time.now.to_i.to_s
+      hashed = Digest::SHA1.hexdigest("#{shared_secret}#{now}")
+      options.merge(:api_key => api_key, :ts => now, :hash => hashed)
+    end
+    
+    def catch_errors(response)
+      if error = response.delete("SlideShareServiceError")
+        case error["Message"]
+        when /failed user authentication/i
+          raise FailedUserAuthentication
+        when /insufficient permission/i
+          raise InsufficientPermission
+        when /slideshow not found/i
+          raise SlideshowNotFound
+        else
+          raise ServiceError, error["Message"]
+        end
+      else
+        response
+      end
+    end
+  end
+end

data/lib/slide_share/errors.rb

@@ -0,0 +1,18 @@
+module SlideShare
+  # Root error
+  # Raised when none of the other errors match
+  class ServiceError < StandardError; end
+  
+  # Raised when API method requires username and password but none
+  # was provided
+  class InsufficientPermission < ServiceError; end
+  
+  # Raised when API method was given incorrect username and/or password
+  class FailedUserAuthentication < ServiceError; end
+  
+  # Raised when no slideshow matches the supplied slideshow_id
+  class SlideshowNotFound < ServiceError; end
+  
+  # Raised when the application has made more than 1000 calls a day
+  class AccountExceededDailyLimit < ServiceError; end
+end

data/lib/slide_share/slideshows.rb

@@ -0,0 +1,127 @@
+module SlideShare
+  class Slideshows
+    attr_accessor :base
+    
+    # This method should only be called internally from an instance of
+    # <tt>SlideShare::Base</tt>.
+    def initialize(base) # :nodoc:
+      self.base = base
+    end
+    
+    # Returns id of newly created slideshow if successful or raises an appropriate
+    # exception if not. Takes the following options:
+    # 
+    # * <tt>:slideshow_description</tt> - Description for the slideshow
+    # * <tt>:slideshow_tags</tt> - Tags for the slideshow. Multiple tags should be separated
+    #   by spaces, using quotes to create individual multiple word tags.
+    # * <tt>:make_src_public</tt> - Set to <tt>true/false</tt> to allow users to download
+    #   the slideshow
+    # * <tt>:make_slideshow_private</tt> - Set to <tt>true/false</tt> to change the privacy
+    #   setting appropriately
+    # 
+    # The following options will only be used if <tt>:make_slideshow_private</tt> is set
+    # <tt>true</tt>:
+    # 
+    # * <tt>:generate_secret_url</tt> - Set to <tt>true/false</tt> to generate a secret URL
+    # * <tt>:allow_embeds</tt> - Set to <tt>true/false</tt> to allow websites to embed
+    #   the private slideshow
+    # * <tt>:share_with_contacts</tt> - Set to <tt>true/false</tt> to allow your contacts to
+    #   view the private slideshow
+    def create(title, filename, username, password, options = {})
+      force_boolean_params_to_letters! options
+      options.merge!(:username => username, :password => password,
+        :slideshow_title => title)
+      params = base.send(:add_required_params, options).map do |key, value|
+        Curl::PostField.content(key.to_s, value)
+      end
+      params << Curl::PostField.file("slideshow_srcfile", File.expand_path(filename))
+      
+      curl = Curl::Easy.new("#{SlideShare::Base.base_uri}/upload_slideshow") do |c|
+        c.multipart_form_post = true
+      end
+      curl.http_post(*params)
+      
+      body = ToHashParser.from_xml(curl.body_str)
+      response = base.send(:catch_errors, body)
+      # I'd presume the id returned was an integer
+      response["SlideShowUploaded"]["SlideShowID"].to_i
+    end
+    
+    # Returns hash of attributes for slideshow if successful or raises an appropriate
+    # exception if not. Takes the following options:
+    # 
+    # * <tt>:username</tt> - SlideShare username of the user _making_ the request
+    # * <tt>:password</tt> - SlideShare password of the user _making_ the request
+    # * <tt>:detailed</tt> - Set to <tt>true</tt> to return additional, detailed information
+    #   about the slideshow (see the official API documentation here[http://www.slideshare.net/developers/documentation]
+    #   for more information). Default is <tt>false</tt>.
+    def find(id, options = {})
+      detailed = convert_to_number(options.delete(:detailed))
+      options[:detailed] = detailed unless detailed.nil?
+      base.send :get, "/get_slideshow", options.merge(:slideshow_id => id)
+    end
+    
+    # Returns true if successful or raises an appropriate exception if not.
+    # Takes the following options:
+    # 
+    # * <tt>:slideshow_title</tt> - Title for the slideshow
+    # * <tt>:slideshow_description</tt> - Description for the slideshow
+    # * <tt>:slideshow_tags</tt> - Tags for the slideshow. Multiple tags should be separated
+    #   by spaces, using quotes to create individual multiple word tags.
+    # * <tt>:make_slideshow_private</tt> - Set to <tt>true/false</tt> to change the privacy
+    #   setting appropriately
+    # 
+    # The following options will only be used if <tt>:make_slideshow_private</tt> is set
+    # <tt>true</tt>:
+    # 
+    # * <tt>:generate_secret_url</tt> - Set to <tt>true/false</tt> to generate a secret URL
+    # * <tt>:allow_embeds</tt> - Set to <tt>true/false</tt> to allow websites to embed
+    #   the private slideshow
+    # * <tt>:share_with_contacts</tt> - Set to <tt>true/false</tt> to allow your contacts to
+    #   view the private slideshow
+    def update(id, username, password, options = {})
+      force_boolean_params_to_letters! options
+      base.send(:post, "/edit_slideshow", options.merge(:slideshow_id => id,
+        :username => username, :password => password))
+      true # This might be too naïve but should have already raised exception if unsuccessful
+    end
+    
+    # Returns true if successful or raises an appropriate exception if not.
+    def delete(id, username, password)
+      base.send :post, "/delete_slideshow", :slideshow_id => id,
+        :username => username, :password => password
+      true # This might be too naïve but should have already raised exception if unsuccessful
+    end
+    
+  private
+    def force_boolean_params_to_letters!(hash)
+      [
+        :make_src_public, :make_slideshow_private, :generate_secret_url,
+        :allow_embeds, :share_with_contacts
+      ].each do |key|
+        value = hash.delete(key)
+        unless value.nil?  
+          hash[key] = convert_to_letter(value, true)
+        end
+      end
+    end
+    
+    def convert_to_letter(value, force = false)
+      case value
+      when false, "N", nil
+        force ? "N" : nil
+      when true, "Y"
+        "Y"
+      end
+    end
+    
+    def convert_to_number(value, force = false)
+      case value
+      when false, 0, nil
+        force ? 0 : nil
+      when true, 1
+        1
+      end
+    end
+  end
+end

data/lib/slideshare.rb

@@ -0,0 +1,16 @@
+require "rubygems"
+require "httparty"
+require "curb"
+
+require "slide_share/errors"
+require "slide_share/base"
+require "slide_share/slideshows"
+
+unless Array.new.respond_to?(:extract_options!)
+  # Via ActiveSupport
+  class Array
+    def extract_options!
+      last.is_a?(Hash) ? pop : {}
+    end
+  end
+end

data/slideshare.gemspec

@@ -0,0 +1,74 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{slideshare}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Saiku.es", "Russell Norris", "Andy Shen"]
+  s.date = %q{2009-10-30}
+  s.email = %q{pablo@saiku.es}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "MIT-LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "init.rb",
+     "lib/slide_share/base.rb",
+     "lib/slide_share/errors.rb",
+     "lib/slide_share/slideshows.rb",
+     "lib/slideshare.rb",
+     "slideshare.gemspec",
+     "spec/fixtures/config.yml",
+     "spec/fixtures/config_missing_api_key.yml",
+     "spec/fixtures/config_missing_shared_secret.yml",
+     "spec/fixtures/delete_slideshow.xml",
+     "spec/fixtures/edit_slideshow.xml",
+     "spec/fixtures/error_failed_auth.xml",
+     "spec/fixtures/error_not_found.xml",
+     "spec/fixtures/error_permissions.xml",
+     "spec/fixtures/get_slideshow.xml",
+     "spec/fixtures/get_slideshow_detailed.xml",
+     "spec/fixtures/sample.txt",
+     "spec/fixtures/upload_slideshow.xml",
+     "spec/slide_share/base_spec.rb",
+     "spec/slide_share/slideshows_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/saiku/slideshare}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Ruby interface for SlideShare API}
+  s.test_files = [
+    "spec/slide_share/base_spec.rb",
+     "spec/slide_share/slideshows_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httparty>, [">= 0.4.3"])
+      s.add_runtime_dependency(%q<curb>, [">= 0.1.4"])
+    else
+      s.add_dependency(%q<httparty>, [">= 0.4.3"])
+      s.add_dependency(%q<curb>, [">= 0.1.4"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0.4.3"])
+    s.add_dependency(%q<curb>, [">= 0.1.4"])
+  end
+end
+

data/spec/fixtures/config.yml

@@ -0,0 +1,4 @@
+# Note: The keys here must be symbols [as shown below]
+# to be correctly parsed in the API calls
+:api_key:         this is not a real api key
+:shared_secret:   this is not a real shared secret

data/spec/fixtures/config_missing_api_key.yml

@@ -0,0 +1,2 @@
+# :api_key:         this is not a real api key
+:shared_secret:   this is not a real shared secret

data/spec/fixtures/config_missing_shared_secret.yml

@@ -0,0 +1,2 @@
+:api_key:         this is not a real api key
+# :shared_secret:   this is not a real shared secret

data/spec/fixtures/delete_slideshow.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<SlideShowDeleted>
+  <SlideShowID>815</SlideShowID>
+</SlideShowDeleted>

data/spec/fixtures/edit_slideshow.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<SlideShowEdited>
+  <SlideShowID>815</SlideShowID>
+</SlideShowEdited>

data/spec/fixtures/error_failed_auth.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<SlideShareServiceError>
+  <Message>2:Failed User authentication</Message>
+</SlideShareServiceError>

data/spec/fixtures/error_not_found.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<SlideShareServiceError>
+  <Message>SlideShow Not Found</Message>
+</SlideShareServiceError>

data/spec/fixtures/error_permissions.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<SlideShareServiceError>
+  <Message>Insufficient Permissions</Message>
+</SlideShareServiceError>

data/spec/fixtures/get_slideshow.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Slideshow>
+  <ID>815</ID>
+  <Title>The Oceanic Six: A Conspiracy of Lies</Title>
+  <Description>The Oceanic Six: A Conspiracy of Lies is a short mocumentary which was an extra feature for the season 4 DVD and Blu-ray. It is intentionally edited in the style of amateur and independent conspiracy documentaries such as Loose Change.</Description>
+  <Status>2</Status>
+  <Username>anon</Username>
+  <URL>http://slideshare.net/path/to/slideshare</URL>
+  <ThumbnailURL>http://slideshare.net/path/to/thumbnail</ThumbnailURL>
+  <ThumbnailSmallURL>http://slideshare.net/path/to/small_thumbnail</ThumbnailSmallURL>
+  <Embed>HTML EMBED code</Embed>
+  <Created>Mon Sep 22 07:40:33 -0600 2008</Created>
+  <Language>en</Language>
+  <Format>ppt</Format>
+  <Download>1</Download>
+</Slideshow>

data/spec/fixtures/get_slideshow_detailed.xml

@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Slideshow>
+  <ID>815</ID>
+  <Title>The Oceanic Six: A Conspiracy of Lies</Title>
+  <Description>The Oceanic Six: A Conspiracy of Lies is a short mocumentary which was an extra feature for the season 4 DVD and Blu-ray. It is intentionally edited in the style of amateur and independent conspiracy documentaries such as Loose Change.</Description>
+  <Status>2</Status>
+  <Username>anon</Username>
+  <URL>http://slideshare.net/path/to/slideshare</URL>
+  <ThumbnailURL>http://slideshare.net/path/to/thumbnail</ThumbnailURL>
+  <ThumbnailSmallURL>http://slideshare.net/path/to/small_thumbnail</ThumbnailSmallURL>
+  <Embed>HTML EMBED code</Embed>
+  <Created>Mon Sep 22 07:40:33 -0600 2008</Created>
+  <Language>en</Language>
+  <Format>ppt</Format>
+  <Download>1</Download>
+  <Tags>
+  </Tags>
+  <NumDownloads>0</NumDownloads>
+  <NumViews>0</NumViews>
+  <NumComments>0</NumComments>
+  <NumFavorites>0</NumFavorites>
+  <NumSlides>1</NumSlides>
+  <RelatedSlideshows>
+    <RelatedSlideshowID rank="10">10</RelatedSlideshowID>
+    <RelatedSlideshowID rank="9">9</RelatedSlideshowID>
+    <RelatedSlideshowID rank="8">8</RelatedSlideshowID>
+    <RelatedSlideshowID rank="7">7</RelatedSlideshowID>
+    <RelatedSlideshowID rank="6">6</RelatedSlideshowID>
+    <RelatedSlideshowID rank="5">5</RelatedSlideshowID>
+    <RelatedSlideshowID rank="4">4</RelatedSlideshowID>
+    <RelatedSlideshowID rank="3">3</RelatedSlideshowID>
+    <RelatedSlideshowID rank="2">2</RelatedSlideshowID>
+    <RelatedSlideshowID rank="1">1</RelatedSlideshowID>
+  </RelatedSlideshows>
+  <PrivacyLevel>0</PrivacyLevel>
+  <SecretURL>0</SecretURL>
+  <AllowEmbed>0</AllowEmbed>
+  <ShareWithContacts>0</ShareWithContacts>
+</Slideshow>

data/spec/fixtures/sample.txt

@@ -0,0 +1,4 @@
+Hmmm
+This is something
+test
+another line

data/spec/fixtures/upload_slideshow.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<SlideShowUploaded>
+  <SlideShowID>815</SlideShowID>
+</SlideShowUploaded>

data/spec/slide_share/base_spec.rb

@@ -0,0 +1,58 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+describe SlideShare::Base do
+  describe "when initializing with an options hash" do
+    it "should require an api key" do
+      lambda {
+        SlideShare::Base.new(:api_key => "this is not a real api key")
+      }.should raise_error(ArgumentError)
+    end
+  
+    it "should require an shared secret" do
+      lambda {
+        SlideShare::Base.new(:shared_secret => "this is not a real shared secret")
+      }.should raise_error(ArgumentError)
+    end
+    
+    it "should raise no errors if provided api key and shared secret" do
+      lambda {
+        SlideShare::Base.new(
+          :api_key       => "this is not a real api key",
+          :shared_secret => "this is not a real shared secret"
+        )
+      }.should_not raise_error
+    end
+  end
+  
+  describe "when initializing with a YAML file" do
+    it "should require an api key" do
+      lambda {
+        SlideShare::Base.new(spec_fixture("config_missing_api_key.yml"))
+      }.should raise_error(ArgumentError)
+    end
+  
+    it "should require an shared secret" do
+      lambda {
+        SlideShare::Base.new(spec_fixture("config_missing_shared_secret.yml"))
+      }.should raise_error(ArgumentError)
+    end
+    
+    it "should raise no errors if provided api key and shared secret" do
+      lambda {
+        SlideShare::Base.new(spec_fixture("config.yml"))
+      }.should_not raise_error
+    end
+  end
+  
+  describe "when accessing slideshow functionality" do
+    before(:each) do
+      @slideshare = SlideShare::Base.new(spec_fixture("config.yml"))
+    end
+    
+    it "should abstract access to the SlideShare::Slideshows class through SlideShare#slideshows" do
+      @slideshow = mock("SlideShare::Slideshows")
+      SlideShare::Slideshows.stub!(:new).and_return(@slideshow)
+      @slideshare.slideshows.should == @slideshow
+    end
+  end
+end

data/spec/slide_share/slideshows_spec.rb

@@ -0,0 +1,150 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+describe SlideShare::Slideshows do
+  before(:all) do
+    @slideshare = SlideShare::Base.new(spec_fixture("config.yml"))
+    @now = Time.now
+    Time.stub!(:now).and_return(@now)
+  end
+  
+  describe "when creating a slideshow" do
+    before(:each) do
+      @upload = spec_fixture("sample.txt")
+      @curl = mock("Curl::Easy instance")
+      Curl::Easy.stub!(:new).and_return(@curl)
+      @curl.stub!(:http_post)
+      @curl.stub!(:body_str).and_return(File.read(spec_fixture("upload_slideshow.xml")))
+    end
+    
+    # it "should generate the proper API call" do
+    #   @slideshare.slideshows.create "A Title", @upload, "user", "pass"
+    # end
+    
+    it "should return the uploaded slideshow's id when successful" do
+      @slideshare.slideshows.create("A Title", @upload, "user", "pass").should == 815
+    end
+    
+    it "should raise SlideShare::FailedUserAuthentication if given bad credentials" do
+      @curl.stub!(:body_str).and_return(File.read(spec_fixture("error_failed_auth.xml")))
+      lambda {
+        @slideshare.slideshows.create "A Title", @upload, "wronguser", "wrongpass"
+      }.should raise_error(SlideShare::FailedUserAuthentication)
+    end
+  end
+  
+  describe "when retrieving a slideshow" do
+    before(:each) do
+      @response = stub_http_response_with("get_slideshow.xml")
+    end
+    
+    it "should generate the proper API call" do
+      SlideShare::Base.should_receive(:get).with("/get_slideshow",
+        :query => add_required_params(@slideshare, :slideshow_id => 815)).and_return(@response)
+      @slideshare.slideshows.find(815)
+    end
+    
+    it "should convert boolean argument for detailed slideshow into numeric values" do
+      SlideShare::Base.should_receive(:get).with("/get_slideshow",
+        :query => add_required_params(@slideshare, :slideshow_id => 815, :detailed => 1)).and_return(@response)
+      @slideshare.slideshows.find(815, :detailed => true)
+    end
+    
+    # I kinda think this sucks but I don't want to make it too brittle.
+    # Also, if this fails it's because of an outdated HTTParty gem.
+    it "should convert the response into a Hash when successful" do
+      @slideshare.slideshows.find(815).is_a?(Hash).should be_true
+    end
+    
+    it "should raise SlideShare::SlideshowNotFound if no slideshow matches id" do
+      stub_http_response_with("error_not_found.xml")
+      lambda {
+        @slideshare.slideshows.find 4815162342
+      }.should raise_error(SlideShare::SlideshowNotFound)
+    end
+    
+    it "should raise SlideShare::FailedUserAuthentication if given bad credentials" do
+      stub_http_response_with("error_failed_auth.xml")
+      lambda {
+        @slideshare.slideshows.find 815, :username => "wrong_user", :password => "wrong_pass"
+      }.should raise_error(SlideShare::FailedUserAuthentication)
+    end
+    
+    it "should raise SlideShare::InsufficientPermission if username and password are needed but not supplied" do
+      stub_http_response_with("error_permissions.xml")
+      lambda {
+        @slideshare.slideshows.find 815
+      }.should raise_error(SlideShare::InsufficientPermission)
+    end
+  end
+  
+  describe "when updating a slideshow" do
+    before(:each) do
+      @response = stub_http_response_with("edit_slideshow.xml")
+    end
+    
+    it "should generate the proper API call" do
+      SlideShare::Base.should_receive(:post).with("/edit_slideshow",
+        :query => add_required_params(@slideshare, :slideshow_id => 815, 
+          :username => "user", :password => "pass")).and_return(@response)
+      @slideshare.slideshows.update(815, "user", "pass")
+    end
+    
+    it "should convert optional argument for :make_slideshow_private" do
+      SlideShare::Base.should_receive(:post).with("/edit_slideshow",
+        :query => add_required_params(@slideshare, :slideshow_id => 815, 
+          :username => "user", :password => "pass",
+          :make_slideshow_private => "Y")).and_return(@response)
+      @slideshare.slideshows.update(815, "user", "pass", :make_slideshow_private => true)
+    end
+    
+    it "should return true if successful" do
+      @slideshare.slideshows.update(815, "user", "pass",
+        :slideshow_title => "Something New").should be_true
+    end
+    
+    it "should raise SlideShare::SlideshowNotFound if no slideshow matches id" do
+      stub_http_response_with("error_not_found.xml")
+      lambda {
+        @slideshare.slideshows.update 4815162342, "user", "pass"
+      }.should raise_error(SlideShare::SlideshowNotFound)
+    end
+    
+    it "should raise SlideShare::FailedUserAuthentication if given bad credentials" do
+      stub_http_response_with("error_failed_auth.xml")
+      lambda {
+        @slideshare.slideshows.update 815, "wrong_user", "wrong_pass"
+      }.should raise_error(SlideShare::FailedUserAuthentication)
+    end
+  end
+  
+  describe "when deleting a slideshow" do
+    before(:each) do
+      @response = stub_http_response_with("delete_slideshow.xml")
+    end
+    
+    it "should generate the proper API call" do
+      SlideShare::Base.should_receive(:post).with("/delete_slideshow",
+        :query => add_required_params(@slideshare, :slideshow_id => 815, 
+          :username => "user", :password => "pass")).and_return(@response)
+      @slideshare.slideshows.delete(815, "user", "pass")
+    end
+    
+    it "should return true if successful" do
+      @slideshare.slideshows.delete(815, "user", "pass").should be_true
+    end
+    
+    it "should raise SlideShare::SlideshowNotFound if no slideshow matches id" do
+      stub_http_response_with("error_not_found.xml")
+      lambda {
+        @slideshare.slideshows.delete 4815162342, "user", "pass"
+      }.should raise_error(SlideShare::SlideshowNotFound)
+    end
+    
+    it "should raise SlideShare::FailedUserAuthentication if given bad credentials" do
+      stub_http_response_with("error_failed_auth.xml")
+      lambda {
+        @slideshare.slideshows.delete 815, "wrong_user", "wrong_pass"
+      }.should raise_error(SlideShare::FailedUserAuthentication)
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format progress
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,54 @@
+require "rubygems"
+gem "rspec"
+require "spec"
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require "slideshare"
+
+def spec_fixture(filename)
+  File.expand_path(File.join(File.dirname(__FILE__), "fixtures", filename))
+end
+
+def valid_configuration(options = {})
+  {
+    :api_key       => "this is not a real api key",
+    :shared_secret => "this is not a real shared secret"
+  }.merge(options)
+end
+
+def stub_time_now
+  # Returning ;)
+  now = Time.now
+  Time.stub!(:now).and_return(now)
+  now
+end
+
+def add_required_params(base, hash)
+  base.send :add_required_params, hash
+end
+
+# Adapted from HTTParty specs
+def stub_http_response_with(filename)
+  format = filename.split('.').last.intern
+  data = File.read(spec_fixture(filename))
+  http = Net::HTTP.new('localhost', 80)
+  
+  response = Net::HTTPOK.new("1.1", 200, "Content for you")
+  response.stub!(:body).and_return(data)
+  http.stub!(:request).and_return(response)
+  
+  http_request = HTTParty::Request.new(Net::HTTP::Get, '')
+  http_request.stub!(:get_response).and_return(response)
+  http_request.stub!(:format).and_return(format)
+  
+  HTTParty::Request.stub!(:new).and_return(http_request)
+  
+  case format
+  when :xml
+    ToHashParser.from_xml(data)
+  when :json
+    JSON.parse(data)
+  else
+    data
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification 
+name: slideshare
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Saiku.es
+- Russell Norris
+- Andy Shen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-30 00:00:00 +11:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.4.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: curb
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.4
+    version: 
+description: 
+email: pablo@saiku.es
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- init.rb
+- lib/slide_share/base.rb
+- lib/slide_share/errors.rb
+- lib/slide_share/slideshows.rb
+- lib/slideshare.rb
+- slideshare.gemspec
+- spec/fixtures/config.yml
+- spec/fixtures/config_missing_api_key.yml
+- spec/fixtures/config_missing_shared_secret.yml
+- spec/fixtures/delete_slideshow.xml
+- spec/fixtures/edit_slideshow.xml
+- spec/fixtures/error_failed_auth.xml
+- spec/fixtures/error_not_found.xml
+- spec/fixtures/error_permissions.xml
+- spec/fixtures/get_slideshow.xml
+- spec/fixtures/get_slideshow_detailed.xml
+- spec/fixtures/sample.txt
+- spec/fixtures/upload_slideshow.xml
+- spec/slide_share/base_spec.rb
+- spec/slide_share/slideshows_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/saiku/slideshare
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Ruby interface for SlideShare API
+test_files: 
+- spec/slide_share/base_spec.rb
+- spec/slide_share/slideshows_spec.rb
+- spec/spec_helper.rb