shout-mouth-communicator 1.0.0

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*.sw?
+.DS_Store

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create ruby-1.9.2@shout_mouth_communicator

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in shout-mouth-communicator.gemspec
+gemspec

data/README.rdoc

@@ -0,0 +1,7 @@
+===Shout Mouth Communicator
+
+	@shout_mouth_client = ShoutMouthCommunicator.new("http://0.0.0.0:4000/xmlrpc.php", "1", "correct", "password")
+	@shout_mouth_client.authorized?
+
+Check out all the possible calls
+	@shout_mouth_client.methods

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

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

@@ -0,0 +1,241 @@
+require 'xmlrpc/client'
+
+class ShoutMouthCommunicator
+
+   def initialize(server, blogid, username, password)
+     @client = XMLRPC::Client.new2(server)
+     @blogid = blogid
+     @username = username
+     @password = password
+     @errors = []
+   end
+   
+   def client
+     @client
+   end  
+
+   def has_errors?
+     @errors.count > 0
+   end
+
+   def errors
+     @errors
+   end
+
+   def response
+     @response
+   end
+
+   def response=(value)
+     @errors = error_parser(value["fault"]["faultString"]) if value.is_a?(Hash) && value.has_key?("fault") && value["fault"]["faultCode"] == 4003
+     @response = value
+   end
+   
+   def authorized?
+     self.response = @client.call('blogger.getUserInfo', "1", @username, @password)
+     !self.response.key?("fault")
+   end
+
+   def tags
+     self.response = @client.call('wp.getTags', "1", @username, @password)
+     self.response
+   end
+   
+   def edit_tag tag_id, name
+     tag = {
+       :tag_id => tag_id,
+       :name => name
+     }
+     self.response = @client.call('shoutmouth.editTag', "1", @username, @password, tag)
+     self.response
+   end
+
+   def categories
+     self.response = @client.call('wp.getCategories', "1", @username, @password)
+     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
+   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
+   end
+
+   def posts limit = 0
+     self.response = @client.call('metaweblog.getRecentPosts', "1", @username, @password, limit)
+     self.response
+   end
+
+   def post post_id
+     self.response = @client.call('metaweblog.getPost', post_id, @username, @password, 2)
+     self.response 
+   end
+
+   def new_post title, description, categories, status, created, tags
+     post = {
+      :title => title, 
+      :description => description,
+      :categories => categories.split(","),
+      :post_status => status,
+      :dateCreated => created,
+      :mt_keywords => tags
+     }
+
+     self.response = @client.call('metaweblog.newPost', "1", @username, @password, post)
+     self.response
+   end
+
+
+   def edit_post post_id, title, description, categories, status, created, tags
+     post = {
+      :title => title, 
+      :description => description,
+      :categories => categories.split(","),
+      :post_status => status,
+      :dateCreated => created,
+      :mt_keywords => tags
+     }
+
+     self.response = @client.call('metaweblog.editPost', post_id, @username, @password, post) 
+     self.response
+   end
+
+   def delete_post post_id
+     self.response = @client.call('blogger.deletePost', "1", post_id, @username, @password, true)
+     self.response
+   end 
+
+   def pages limit = 10000000
+     self.response = @client.call('wp.getPages', "1", @username, @password, limit)
+     self.response
+   end
+
+   def page page_id
+     self.response = @client.call('wp.getPage', "1", page_id, @username, @password)
+     self.response
+   end
+
+   def new_page title, body, status, order, parent_id
+     page = {
+       :title => title,
+       :description => body,
+       :page_status => status,
+       :wp_page_order => order,
+       :wp_page_parent_id => parent_id
+     }
+     self.response = @client.call('wp.newPage', "1", @username, @password, page).to_i
+     self.response
+   end
+
+   def edit_page page_id, title, body, status, order, parent_id
+     page = {
+       :postid => page_id,
+       :title => title,
+       :description => body,
+       :page_status => status,
+       :wp_page_order => order,
+       :wp_page_parent_id => parent_id
+     }
+     self.response = @client.call('wp.newPage', "1", @username, @password, page).to_i
+     self.response
+   end
+
+   def delete_page page_id 
+     self.response = @client.call('wp.deletePage', "1", @username, @password, page_id) 
+     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
+   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
+   end
+
+   #status list = approve, spam or inactive
+   def edit_comment comment_id, content, author, author_url, author_email, status
+     comment = {
+       :content => content,
+       :author => author,
+       :author_url => author_url,
+       :author_email => author_email,
+       :status => status
+     }
+     self.response = @client.call('wp.editComment', "1", @username, @password, comment_id, comment)
+     self.response
+   end
+
+   def settings
+     self.response = @client.call('wp.getOptions', "1", @username, @password)
+     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
+   end
+
+   def users
+     self.response = @client.call('wp.getAuthors',"1", @username, @password)
+     self.response
+   end
+
+   def current_user
+     self.response = @client.call('blogger.getUserInfo', "1", @username, @password)
+     self.response
+   end
+
+   def add_user email, password, firstname, lastname
+     user = {
+       :email => email,
+       :password => password,
+       :firstname => firstname,
+       :lastname => lastname
+     }
+     self.response = @client.call('shoutmouth.addUser', "1", @username, @password, user)
+     self.response
+   end
+
+   def edit_user user_id, email, password, firstname, lastname
+     user = {
+       :user_id => user_id,
+       :email => email,
+       :password => password,
+       :firstname => firstname,
+       :lastname => lastname
+     }
+     self.response = @client.call('shoutmouth.editUser', "1", @username, @password, user)
+     self.response
+   end
+
+   def delete_user user_id
+     self.response = @client.call('shoutmouth.deleteUser', "1", @username, @password, user_id)
+     self.response
+   end
+
+   def upload_file name, bits
+     file = {
+       :bits => bits,
+       :name => name
+     }
+     self.response = @client.call('metaweblog.newMediaObject', "1", @username, @password, file) 
+     self.response
+   end
+   
+   private 
+   def error_parser string
+     string.gsub("[","").gsub("]","").gsub("\"", "").split(",")
+   end
+ end

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

@@ -0,0 +1,7 @@
+module Shout
+  module Mouth
+    module Communicator
+      VERSION = "1.0.0"
+    end
+  end
+end

data/lib/shout-mouth-communicator.rb

@@ -0,0 +1 @@
+require 'shout-mouth-communicator/shout-mouth-communicator'

data/shout-mouth-communicator.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "shout-mouth-communicator/version"
+
+Gem::Specification.new do |s|
+  s.name        = "shout-mouth-communicator"
+  s.version     = Shout::Mouth::Communicator::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Dan Watson"]
+  s.email       = ["dan@dotnetguy.co.uk"]
+  s.homepage    = "https://github.com/dotnetguyuk/shout-mouth-communicator"
+  s.summary     = %q{Shout Mouth Blog Engine API Wrapper}
+  s.description = %q{An xmlrpc client that allows administration of the Shout Mouth blog engine"}
+
+  s.rubyforge_project = "shout-mouth-communicator"
+
+  s.files         = `git ls-files`.split("\n")
+  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_development_dependency('racksh')
+  s.add_development_dependency('thin')
+  s.add_development_dependency('rspec')
+end

data/specs/fakes/xmlrpc_server.rb

@@ -0,0 +1,71 @@
+require 'thin'
+require 'xmlrpc/marshal'
+
+class XMLrpcServer
+  
+  def initialize(options={})
+    port = options[:port] || 4000
+    @thread = Thread.new { Rack::Handler::Thin.run(self, :Port => port) }
+    sleep 1
+  end
+ 
+  def call(env)
+    begin
+      request = Rack::Request.new(env)
+      #generate the xml
+      xml =  load_xml_from_request(request.body.read, request.params)
+      #create xmlrpc request call
+      call = XMLRPC::Marshal.load_call(xml)
+      # convert *.getPost to get_post
+      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
+      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')
+      #send the fake response
+      [ 200, { 'Content-Type' => 'text/xml', 'Content-Length' => response.length.to_s}, [response]]
+    rescue StandardError => bang
+      message = bang.backtrace
+      [500, { 'Content-Type' => 'text/plain', 'Content-Length' => message.to_s.length.to_s}, [message.to_s]]
+    end
+  end 
+
+  def kill
+    Thread.kill(@thread)
+  end
+
+  private
+  def load_xml_from_request request_body, request_params
+    if request_body.empty?
+      hash = request_params
+      request_body = (hash.keys + hash.values).join
+    end
+    return request_body.gsub(">true<", ">1<").gsub(">false<", ">0<")
+  end
+  
+  def does_not_need_authentication?(method)
+    ["list_methods",
+      "get_capabilities", 
+      "multicall", 
+      "say_hello", 
+      "add_two_numbers", 
+      "supported_methods", 
+      "supported_text_filters", 
+      "get_trackback_pings",
+      "get_pingbacks",
+      "ping"].include?(method)
+  end
+
+  def authenticated?(call)
+    #this is a dumbed down auth method for the fake server
+    #will return true if the call contains the words correct password
+    #else it will return false
+    call.to_s.gsub(/correct/).any? && call.to_s.gsub(/password/).any?
+  end
+  
+  def get_response_for(method)
+    File.open(File.join(File.expand_path('../xmlrpc_server_responses', __FILE__), "#{method}.xml")).read
+  end
+end

data/specs/fakes/xmlrpc_server_responses/add_user.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0"?>
+<methodResponse>
+  <params>
+    <param>
+      <value>
+        <boolean>1</boolean>
+      </value>
+    </param>
+  </params>
+</methodResponse>

data/specs/fakes/xmlrpc_server_responses/bad_authentication.xml

@@ -0,0 +1,30 @@
+<?xml version="1.0"?>
+<methodResponse>
+  <params>
+    <param>
+      <value>
+        <struct>
+          <member>
+            <name>fault</name>
+            <value>
+              <struct>
+                <member>
+                  <name>faultCode</name>
+                  <value>
+                    <int>403</int>
+                  </value>
+                </member>
+                <member>
+                  <name>faultString</name>
+                  <value>
+                    <string>Bad login/pass combination.</string>
+                  </value>
+                </member>
+              </struct>
+            </value>
+          </member>
+        </struct>
+      </value>
+    </param>
+  </params>
+</methodResponse>

data/specs/fakes/xmlrpc_server_responses/delete_page.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0"?>
+<methodResponse>
+  <params>
+    <param>
+      <value>
+        <boolean>1</boolean>
+      </value>
+    </param>
+  </params>
+</methodResponse>

data/specs/fakes/xmlrpc_server_responses/delete_post.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0"?>
+<methodResponse>
+  <params>
+    <param>
+      <value>
+        <boolean>1</boolean>
+      </value>
+    </param>
+  </params>
+</methodResponse>

data/specs/fakes/xmlrpc_server_responses/delete_user.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0"?>
+<methodResponse>
+  <params>
+    <param>
+      <value>
+        <boolean>1</boolean>
+      </value>
+    </param>
+  </params>
+</methodResponse>

data/specs/fakes/xmlrpc_server_responses/edit_category.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0"?>
+<methodResponse>
+  <params>
+    <param>
+      <value>
+        <boolean>1</boolean>
+      </value>
+    </param>
+  </params>
+</methodResponse>

data/specs/fakes/xmlrpc_server_responses/edit_comment.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0"?>
+<methodResponse>
+  <params>
+    <param>
+      <value>
+        <boolean>1</boolean>
+      </value>
+    </param>
+  </params>
+</methodResponse>

data/specs/fakes/xmlrpc_server_responses/edit_page.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0"?>
+<methodResponse>
+  <params>
+    <param>
+      <value>
+        <string>10</string>
+      </value>
+    </param>
+  </params>
+</methodResponse>

data/specs/fakes/xmlrpc_server_responses/edit_post.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0"?>
+<methodResponse>
+  <params>
+    <param>
+      <value>
+        <boolean>1</boolean>
+      </value>
+    </param>
+  </params>
+</methodResponse>
+

data/specs/fakes/xmlrpc_server_responses/edit_tag.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0"?>
+<methodResponse>
+  <params>
+    <param>
+      <value>
+        <boolean>1</boolean>
+      </value>
+    </param>
+  </params>
+</methodResponse>

data/specs/fakes/xmlrpc_server_responses/edit_user.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0"?>
+<methodResponse>
+  <params>
+    <param>
+      <value>
+        <boolean>1</boolean>
+      </value>
+    </param>
+  </params>
+</methodResponse>

data/specs/fakes/xmlrpc_server_responses/get_authors.xml

@@ -0,0 +1,41 @@
+<?xml version="1.0"?>
+<methodResponse>
+  <params>
+    <param>
+      <value>
+        <array>
+          <data>
+            <value>
+              <struct>
+                <member>
+                  <name>user_id</name>
+                  <value>
+                    <string>1</string>
+                  </value>
+                </member>
+                <member>
+                  <name>user_login</name>
+                  <value>
+                    <string>dan@shout_mouth.com</string>
+                  </value>
+                </member>
+                <member>
+                  <name>display_name</name>
+                  <value>
+                    <string>Daniel Watson</string>
+                  </value>
+                </member>
+                <member>
+                  <name>user_email</name>
+                  <value>
+                    <string>dan@shout_mouth.com</string>
+                  </value>
+                </member>
+              </struct>
+            </value>
+          </data>
+        </array>
+      </value>
+    </param>
+  </params>
+</methodResponse>