shout-mouth-communicator 1.0.2 → 1.1.0

data/lib/shout-mouth-communicator/shout-mouth-communicator.rb

@@ -1,12 +1,12 @@
-require 'xmlrpc/client'
+require 'rapuncel'
 
 class XmlParseError < StandardError; end
 class NotAuthenticatedError < StandardError; end
 
 class ShoutMouthCommunicator
 
-   def initialize(server, blogid, username, password)
-     @client = XMLRPC::Client.new2(server)
+   def initialize(url, path, port, blogid, username, password)
+     @client = Rapuncel::Client.new :host => url, :port => port, :path => path
      @blogid = blogid
      @username = username
      @password = password
@@ -30,10 +30,10 @@ class ShoutMouthCommunicator
    end
 
    def response=(value)
-     if value.is_a?(Hash) && value.has_key?("fault")
-       case value["fault"]["faultCode"]
+     if value.is_a?(Hash) && value.has_key?(:fault)
+       case value[:fault][:faultCode]
          when 4003
-          @errors = error_parser(value["fault"]["faultString"])
+          @errors = error_parser(value[:fault][:faultString])
          when 403
            raise NotAuthenticatedError
          when -32700
@@ -49,7 +49,7 @@ class ShoutMouthCommunicator
    
    def authorized?
      begin
-      self.response = @client.call('blogger.getUserInfo', "1", @username, @password)
+      self.response = @client.call('blogger.getUserInfo', @blogid, @username, @password).result
       true
      rescue NotAuthenticatedError
        return false
@@ -57,7 +57,7 @@ class ShoutMouthCommunicator
    end
 
    def tags
-     self.response = @client.call('wp.getTags', "1", @username, @password)
+     self.response = @client.call('wp.getTags', @blogid, @username, @password).result
      self.response
    end
    
@@ -66,34 +66,34 @@ class ShoutMouthCommunicator
        :tag_id => tag_id,
        :name => name
      }
-     self.response = @client.call('shoutmouth.editTag', "1", @username, @password, tag)
+     self.response = @client.call('shoutmouth.editTag', @blogid, @username, @password, tag).result
      self.response
    end
 
    def categories
-     self.response = @client.call('wp.getCategories', "1", @username, @password)
+     self.response = @client.call('wp.getCategories', @blogid, @username, @password).result
      self.response
    end
 
    def new_category name, description
      category = {:name => name, :slug => "not relevant", :parent_id => "0", :description => description}
-     self.response = @client.call('wp.newCategory', "1", @username, @password, category)
+     self.response = @client.call('wp.newCategory', @blogid, @username, @password, category).result
      self.response
    end
    
    def edit_category category_id, name 
      category = {:category_id => category_id, :category => name}
-     self.response = @client.call('shoutmouth.editCategory', "1", @username, @password, category)
+     self.response = @client.call('shoutmouth.editCategory', @blogid, @username, @password, category).result
      self.response
    end
 
    def posts limit = 0
-     self.response = @client.call('metaweblog.getRecentPosts', "1", @username, @password, limit)
+     self.response = @client.call('metaweblog.getRecentPosts', @blogid, @username, @password, limit).result
      self.response
    end
 
    def post post_id
-     self.response = @client.call('metaweblog.getPost', post_id, @username, @password, 2)
+     self.response = @client.call('metaweblog.getPost', post_id, @username, @password, 2).result
      self.response 
    end
 
@@ -107,7 +107,7 @@ class ShoutMouthCommunicator
       :mt_keywords => tags
      }
 
-     self.response = @client.call('metaweblog.newPost', "1", @username, @password, post)
+     self.response = @client.call('metaweblog.newPost', @blogid, @username, @password, post).result
      self.response
    end
 
@@ -122,22 +122,22 @@ class ShoutMouthCommunicator
       :mt_keywords => tags
      }
 
-     self.response = @client.call('metaweblog.editPost', post_id, @username, @password, post) 
+     self.response = @client.call('metaweblog.editPost', post_id, @username, @password, post).result
      self.response
    end
 
    def delete_post post_id
-     self.response = @client.call('blogger.deletePost', "1", post_id, @username, @password, true)
+     self.response = @client.call('blogger.deletePost', @blogid, post_id, @username, @password, true).result
      self.response
    end 
 
    def pages limit = 10000000
-     self.response = @client.call('wp.getPages', "1", @username, @password, limit)
+     self.response = @client.call('wp.getPages', @blogid, @username, @password, limit).result
      self.response
    end
 
    def page page_id
-     self.response = @client.call('wp.getPage', "1", page_id, @username, @password)
+     self.response = @client.call('wp.getPage', @blogid, page_id, @username, @password).result
      self.response
    end
 
@@ -149,7 +149,7 @@ class ShoutMouthCommunicator
        :wp_page_order => order,
        :wp_page_parent_id => parent_id
      }
-     self.response = @client.call('wp.newPage', "1", @username, @password, page).to_i
+     self.response = @client.call('wp.newPage', @blogid, @username, @password, page).result.to_i
      self.response
    end
 
@@ -162,24 +162,24 @@ class ShoutMouthCommunicator
        :wp_page_order => order,
        :wp_page_parent_id => parent_id
      }
-     self.response = @client.call('wp.newPage', "1", @username, @password, page).to_i
+     self.response = @client.call('wp.newPage', @blogid, @username, @password, page).result.to_i
      self.response
    end
 
    def delete_page page_id 
-     self.response = @client.call('wp.deletePage', "1", @username, @password, page_id) 
+     self.response = @client.call('wp.deletePage', @blogid, @username, @password, page_id).result
      self.response
    end
 
    #status list = active, spam or hold
    def comments status = "active"
-     self.response = @client.call('wp.getComments', "1", @username, @password, { :status => status })
+     self.response = @client.call('wp.getComments', @blogid, @username, @password, { :status => status }).result
      self.response
    end
 
    #status list = active, spam or hold
    def comments_for_post post_id, status = "active"
-     self.response = @client.call('wp.getComments', "1", @username, @password, { :post_id => post_id, :status => status })
+     self.response = @client.call('wp.getComments', @blogid, @username, @password, { :post_id => post_id, :status => status }).result
      self.response
    end
 
@@ -192,28 +192,28 @@ class ShoutMouthCommunicator
        :author_email => author_email,
        :status => status
      }
-     self.response = @client.call('wp.editComment', "1", @username, @password, comment_id, comment)
+     self.response = @client.call('wp.editComment', @blogid, @username, @password, comment_id, comment).result
      self.response
    end
 
    def settings
-     self.response = @client.call('wp.getOptions', "1", @username, @password)
+     self.response = @client.call('wp.getOptions', @blogid, @username, @password).result
      self.response
    end
 
    #{"blog_title" => "Hello World!", "blog_tagline" => "tagg!"}
    def edit_settings settings
-     self.response = @client.call('wp.setOptions', "1", @username, @password, settings)
+     self.response = @client.call('wp.setOptions', @blogid, @username, @password, settings).result
      self.response
    end
 
    def users
-     self.response = @client.call('wp.getAuthors',"1", @username, @password)
+     self.response = @client.call('wp.getAuthors', @blogid, @username, @password).result
      self.response
    end
 
    def current_user
-     self.response = @client.call('blogger.getUserInfo', "1", @username, @password)
+     self.response = @client.call('blogger.getUserInfo', @blogid, @username, @password).result
      self.response
    end
 
@@ -224,7 +224,7 @@ class ShoutMouthCommunicator
        :firstname => firstname,
        :lastname => lastname
      }
-     self.response = @client.call('shoutmouth.addUser', "1", @username, @password, user)
+     self.response = @client.call('shoutmouth.addUser', @blogid, @username, @password, user).result
      self.response
    end
 
@@ -236,12 +236,12 @@ class ShoutMouthCommunicator
        :firstname => firstname,
        :lastname => lastname
      }
-     self.response = @client.call('shoutmouth.editUser', "1", @username, @password, user)
+     self.response = @client.call('shoutmouth.editUser', @blogid, @username, @password, user).result
      self.response
    end
 
    def delete_user user_id
-     self.response = @client.call('shoutmouth.deleteUser', "1", @username, @password, user_id)
+     self.response = @client.call('shoutmouth.deleteUser', @blogid, @username, @password, user_id).result
      self.response
    end
 
@@ -250,7 +250,7 @@ class ShoutMouthCommunicator
        :bits => bits,
        :name => name
      }
-     self.response = @client.call('metaweblog.newMediaObject', "1", @username, @password, file) 
+     self.response = @client.call('metaweblog.newMediaObject', @blogid, @username, @password, file).result
      self.response
    end
    

data/lib/shout-mouth-communicator/version.rb

@@ -1,7 +1,7 @@
 module Shout
   module Mouth
     module Communicator
-      VERSION = "1.0.2"
+      VERSION = "1.1.0"
     end
   end
 end

data/shout-mouth-communicator.gemspec

@@ -18,7 +18,9 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,specs,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-  
+
+  s.add_dependency('rapuncel')
+
   s.add_development_dependency('thin')
   s.add_development_dependency('rspec')
 end

data/specs/fakes/xmlrpc_server.rb

@@ -20,7 +20,7 @@ class XMLrpcServer
       method = call[0].gsub(/(.*)\.(.*)/, '\2').gsub(/([A-Z])/, '_\1').downcase
       # fake authentocation
       does_not_need_authentication?(method) ? authenticated = true : authenticated = authenticated?(call)
-      # if the fake reponse header has been set overide the response file that will be sent back to the client
+      # if the fake reponse header has been set overide the response file that will be sent back to the client 
       method = env["HTTP_RESPONSE_FILE"] unless env["HTTP_RESPONSE_FILE"].nil? 
       #raise  xmlrpc error response or get the xml response from the correct file
       authenticated ? response = get_response_for(method)  : response = get_response_for('bad_authentication')

data/specs/shout_mouth_client_specification.rb

@@ -3,16 +3,24 @@ require File.expand_path('../../lib/shout-mouth-communicator', __FILE__)
 
 describe "Shout Mouth RPC API" do
   
+  HOST = "0.0.0.0"
+  PORT = "4000"
+  PATH = "/xmlrpc.php"
+  BLOGID = "1"
+  USERNAME = "correct"
+  PASSWORD = "password"
+
+
   before(:all) do
-    @shout_mouth_client = ShoutMouthCommunicator.new("http://0.0.0.0:4000/xmlrpc.php", "1", "correct", "password")
+    @shout_mouth_client = ShoutMouthCommunicator.new(HOST, PATH, PORT, BLOGID, USERNAME, PASSWORD)
   end
   
   after(:each) do
-    @shout_mouth_client.client.http_header_extra = nil
+    @shout_mouth_client.client.connection.headers = {}
   end
 
   it "should disallow authorization to the system when credentials are incorrect" do
-		shout_mouth_client = ShoutMouthCommunicator.new("http://0.0.0.0:4000/xmlrpc.php", "1", "wrong", "password")
+		shout_mouth_client = ShoutMouthCommunicator.new(HOST, PATH, PORT, BLOGID, "wrong", PASSWORD)
     shout_mouth_client.authorized?.should be_false
   end
 
@@ -22,10 +30,10 @@ describe "Shout Mouth RPC API" do
 
   it "should return a list of correct tags" do 
     tags = @shout_mouth_client.tags
-    tags[0].should include "tag_id"=>"1"
-    tags[1].should include "tag_id"=>"2"
-    tags[2].should include "tag_id"=>"3"
-    tags[3].should include "tag_id"=>"4"
+    tags[0].should include :tag_id => "1"
+    tags[1].should include :tag_id => "2"
+    tags[2].should include :tag_id => "3"
+    tags[3].should include :tag_id => "4"
   end
 
   it "should return the correct response when a tag is edited" do
@@ -35,10 +43,10 @@ describe "Shout Mouth RPC API" do
   
   it "should return a list of correct categories" do
     categories = @shout_mouth_client.categories
-    categories[0].should include "categoryId"=> "1"
-    categories[1].should include "categoryId"=> "2"
-    categories[2].should include "categoryId"=> "3"
-    categories[3].should include "categoryId"=> "4"
+    categories[0].should include :categoryId => "1"
+    categories[1].should include :categoryId => "2"
+    categories[2].should include :categoryId => "3"
+    categories[3].should include :categoryId => "4"
   end
 
   it "should return the correct response when a category has been created" do
@@ -54,13 +62,13 @@ describe "Shout Mouth RPC API" do
   it "should return a correct list of posts" do
     posts = @shout_mouth_client.posts 
     posts.count.should == 2
-    posts[0]["title"].should == "This is how we roll"
-    posts[1]["title"].should == "New Post 1"  
+    posts[0][:title].should == "This is how we roll"
+    posts[1][:title].should == "New Post 1"  
   end
   
   it "should return a post when the get_post method is called" do
     post = @shout_mouth_client.post 1
-    post["title"].should == "This is how we roll"
+    post[:title].should == "This is how we roll"
   end
 
   it "should return a correct response when a new post is added" do
@@ -80,12 +88,12 @@ describe "Shout Mouth RPC API" do
 
   it "should return a correct list of pages when the pages method is called" do
     pages = @shout_mouth_client.pages
-    pages.first["title"].should == "bang"
+    pages.first[:title].should == "bang"
   end
 
   it "should return a correct page when the page method is called" do
     page = @shout_mouth_client.page 8
-    page["title"].should == "bang"
+    page[:title].should == "bang"
   end
 
   it "should return a correct response when the new post method is called" do
@@ -94,7 +102,7 @@ describe "Shout Mouth RPC API" do
   end
 
   it "should return a correct response when the edit page method is called" do
-    @shout_mouth_client.client.http_header_extra = {"response_file" => "edit_page"}
+    @shout_mouth_client.client.connection.headers = {"response_file" => "edit_page"}
     response = @shout_mouth_client.edit_page 10, "new page 123", "body", "publish", 1, 0
     response.should == 10
   end
@@ -106,16 +114,16 @@ describe "Shout Mouth RPC API" do
 
   it "should return comments for a post when the get post comments methods is called" do
     comments = @shout_mouth_client.comments_for_post 4
-    comments.first["user_id"].should == "ham@ok.com"
+    comments.first[:user_id].should == "ham@ok.com"
   end
 
   it "should return no comments for a post when the get comments method is called with the spam flag" do
-    @shout_mouth_client.client.http_header_extra = {"response_file" => "get_comments_spam"}
+    @shout_mouth_client.client.connection.headers = {"response_file" => "get_comments_spam"}
     @shout_mouth_client.comments_for_post(4, "spam").should be_empty
   end
 
   it "should return all active comments when the comments method is called" do
-    @shout_mouth_client.client.http_header_extra = {"response_file" => "get_comments_all"}
+    @shout_mouth_client.client.connection.headers = {"response_file" => "get_comments_all"}
     comments = @shout_mouth_client.comments
     comments.count.should == 2
   end
@@ -127,24 +135,24 @@ describe "Shout Mouth RPC API" do
 
   it "should return a list of avaliable settings for the shout mouth instance when the settings method is called" do
     settings = @shout_mouth_client.settings
-    settings["software_name"]["value"].should == "Shout Mouth Blog Engine"
-    settings["administrator_email"]["value"].should == "admin@yourserver.com"
+    settings[:software_name][:value].should == "Shout Mouth Blog Engine"
+    settings[:administrator_email][:value].should == "admin@yourserver.com"
   end
 
   it "should return a setting when a settings is edited" do
     setting = @shout_mouth_client.edit_settings({"blog_title" => "ttle"})
-    setting["blog_title"]["value"].should == "ttle"
+    setting[:blog_title][:value].should == "ttle"
   end
 
   it "should return all users when the user method is called" do
     users = @shout_mouth_client.users
-    users.first["user_email"].should == "dan@shout_mouth.com"
+    users.first[:user_email].should == "dan@shout_mouth.com"
   end
 
   it "should return information about the current user when the current user method is called" do
     user = @shout_mouth_client.current_user    
-    user["firstname"].should == "Daniel"
-    user["lastname"].should == "Watson"
+    user[:firstname].should == "Daniel"
+    user[:lastname].should == "Watson"
   end
 
   it "should return true when the add use method is called" do
@@ -160,23 +168,23 @@ describe "Shout Mouth RPC API" do
   end
 
   it "should return the correct url when a file is uploaded" do
-    @shout_mouth_client.upload_file("Austria.gif", [])["url"].should == "http://0.0.0.0:4000/uploads/Austria.gif"
+    @shout_mouth_client.upload_file("Austria.gif", [])[:url].should == "http://0.0.0.0:4000/uploads/Austria.gif"
   end
 
   it "should have errors if the response contains validation errors" do
-    @shout_mouth_client.client.http_header_extra = {"response_file" => "validation_error"}
+    @shout_mouth_client.client.connection.headers = {"response_file" => "validation_error"}
     @shout_mouth_client.edit_user("1", "email@addess.com", "password", "", "")
     @shout_mouth_client.has_errors?.should be_true
     @shout_mouth_client.errors.count.should == 3
   end
 
   it "should raise an XmlParseError if the xml passed is blank" do
-    @shout_mouth_client.client.http_header_extra = {"response_file" => "xml_parse_error"}
+    @shout_mouth_client.client.connection.headers = {"response_file" => "xml_parse_error"}
     lambda{ @shout_mouth_client.upload_file("",[]) }.should raise_error(XmlParseError)
   end 
 
   it "should raise an NoMethodError if there is a method called with no endpoint" do
-    @shout_mouth_client.client.http_header_extra = {"response_file" => "nomethod_error"}
+    @shout_mouth_client.client.connection.headers = {"response_file" => "nomethod_error"}
     lambda{ @shout_mouth_client.upload_file("",[])}.should raise_error(NoMethodError)
   end
 end

metadata

@@ -2,7 +2,7 @@
 name: shout-mouth-communicator
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors: 
 - Dan Watson
@@ -10,11 +10,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-24 00:00:00 +01:00
+date: 2011-05-26 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: thin
+  name: rapuncel
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
@@ -22,10 +22,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version 
         version: "0"
-  type: :development
+  type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: thin
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -35,6 +35,17 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
 description: An xmlrpc client that allows administration of the Shout Mouth blog engine"
 email: 
 - dan@dotnetguy.co.uk