xmlrpc_controller 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f70cdf8556554e04b96160d5bbaa2258d937e3e6
+  data.tar.gz: d5ebf702bfe7330d4e7a9fb8423ea6107f8ca39b
+SHA512:
+  metadata.gz: 1543976a26c3d950331b81fc603e332cb791f7ad5b55bcae4b32eab9b344afaa0a97016cb9f166fef23a20382bc445b917cd7fe7588015fe45ae1aadff3bc089
+  data.tar.gz: 16c11385de36597aa18557df4c85ec76c0b17c9c6ebc3811870b3ba488c5df7a3c341e87e59b2d2a748d53ef974e8a360555efcf16d043a5e8e3cc9da69628c9

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in xmlrpc_controller.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Nam Chu Hoai
+
+MIT License
+
+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.md

@@ -0,0 +1,27 @@
+# XmlrpcController
+
+Small gem to accept XMLRPC calls in your controller, written for providing Webhooks as a IFTTT trigger by pretending to be a Wordpress blog. Entirely inspired from [femto113/node-ifttt-webhook](https://github.com/femto113/node-ifttt-webhook) which is entirely inspired from [captn3m0/ifttt-webhook](https://github.com/captn3m0/ifttt-webhook)
+
+## How to use
+
+### For ITTT
+
+````
+class RpcController < ApplicationController
+  include XmlrpcController
+  # you want to be selective with this
+  skip_before_filter :verify_authenticity_token
+  
+  before_filter :ifttt_webhook_defaults
+
+  # override when needed, by default it will POST a request to the url as specified in the tags, body is the payload
+  def ifttt_new_post(title, body, categories, tags)
+  end
+  
+end
+
+````
+
+### Other Uses
+
+The module will call try to call the method defined on the controller as specified in the RPC call with a Nokogiri Object as the argument.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/xmlrpc_controller/version.rb

@@ -0,0 +1,3 @@
+module XmlrpcController
+  VERSION = "0.0.1"
+end

data/lib/xmlrpc_controller.rb

@@ -0,0 +1,64 @@
+require "xmlrpc_controller/version"
+
+module XmlrpcController
+
+  # the main method handling the RPC request. It parses the method name, and passes the Nokogiri XML node that represents the params
+  # @@xmlrpc_method_name_map contains a map to resolve for non-ruby method names (with a . for example)
+  def rpc
+    parsed_request = Nokogiri::XML.parse(request.body.read)
+    method_name = parsed_request.xpath('methodCall/methodName').text
+    method_params = parsed_request.xpath('methodCall/params')
+    method_name = @@xmlrpc_method_name_map[method_name] || method_name
+    self.send(method_name, method_params)
+  end
+
+  # default handling methods for IFTTT to make a simple Webhook bridge
+  def ifttt_defaults
+    @@xmlrpc_method_name_map ||= {}
+    @@xmlrpc_method_name_map.merge!({
+      "metaWeblog.getRecentPosts" => :metaWeblog_getRecentPosts,
+      "mt.supportedMethods" => :mt_supportedMethods,
+      "metaWeblog.newPost" => :metaWeblog_newPost,
+      "metaWeblog.getCategories" => :metaWeblog_getCategories,
+      "wp.newCategory" => :wp_newCategory
+      })
+  end
+
+  # actual method doing the webhook request
+  def ifttt_new_post(title, body, categories, tags)
+    # default protocol to respond to a new post is to POST a request to the url as specified in the tags, body is the payload
+    HTTParty.post(tags.first, body: body)
+  end
+
+  # convenience method to send back a xmlrpc response
+  def rpc_response(value)
+    render inline: "xml.instruct! :xml, :version=>'1.0' \n xml.methodResponse { xml.params { xml.param { #{value} }}}", type: :builder, content_type: "text/xml"
+  end
+
+  # utility methods to make IFTTT believe we are a wordpress blog
+  def mt_supportedMethods(*args)
+    rpc_response("xml.value { xml.array {xml.data { xml.value { xml.string 'metaWeblog.getRecentPosts' } \n xml.value { xml.string 'metaWeblog.newPost' } }}} ")
+  end
+
+  def metaWeblog_getRecentPosts(*args)
+    rpc_response("xml.value { xml.array { xml.data }}")
+  end
+
+  def metaWeblog_newPost(args)
+    new_post_params = Hash.from_xml(args.children[3].to_s)['param']['value']['struct']['member']
+    title = new_post_params[0]['value']['string']
+    body = new_post_params[1]['value']['string']
+    categories = (new_post_params[2]['value']['array']['data']['value'].class == Array ? new_post_params[2]['value']['array']['data']['value'].map { |e| e['string'] } : [new_post_params[2]['value']['array']['data']['value']['string']] )
+    tags = (new_post_params[3]['value']['array']['data']['value'].class == Array ? new_post_params[3]['value']['array']['data']['value'].map { |e| e['string'] } : [new_post_params[3]['value']['array']['data']['value']['string']] )
+    ifttt_new_post(title, body, categories, tags)
+    rpc_response("xml.value 'nothing'")
+  end
+
+  def metaWeblog_getCategories(args)
+    rpc_response("xml.value { xml.array { xml.data }}")
+  end
+
+  def wp_newCategory(args)
+    rpc_response("xml.value { xml.array { xml.data }}")
+  end
+end

data/xmlrpc_controller.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'xmlrpc_controller/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "xmlrpc_controller"
+  spec.version       = XmlrpcController::VERSION
+  spec.authors       = ["Nam Chu Hoai"]
+  spec.email         = ["nambrot@googlemail.com"]
+  spec.summary       = "Include XMLRPC into any Controller"
+  spec.description   = "Utility methods to work with XMLRPC"
+  spec.homepage      = "https://github.com/nambrot/xmlrpc_controller"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: xmlrpc_controller
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nam Chu Hoai
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Utility methods to work with XMLRPC
+email:
+- nambrot@googlemail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/xmlrpc_controller.rb
+- lib/xmlrpc_controller/version.rb
+- xmlrpc_controller.gemspec
+homepage: https://github.com/nambrot/xmlrpc_controller
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Include XMLRPC into any Controller
+test_files: []