ruby-swift 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 26f071b6b85789f1f09f967888fed8cca992a3a6
+  data.tar.gz: ddd106544903cd824eee8640221a592d648305d1
+SHA512:
+  metadata.gz: 97b53f999942ad4a5f46e73508504e88173ab6f1bc1707e4379a4ff5abfbad5b7e6499b7f7ea079e87720e86e0ac2fdca258707b35bee80bf28104494be4a77f
+  data.tar.gz: 0256813bff346f7da02bf5fbfff0bc7bbc1423a02404f94f2c992eb136e282fd83ed78e14d8be691a8da0ddf7fef0ae730b5c3d56e09daab0942a630a16c931d

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Andrew Buntine
+
+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,101 @@
+RubySwift
+=========
+
+A ruby wrapper of the [Swift Digital Suite Mail House API](https://suite.swiftdigital.com.au/login).
+
+This is currently a relatively crude wrapper and does not tidy responses from Swift a lot.
+
+INSTALLATION
+------------
+  You can install the library via Rubygems:
+
+    $ gem install ruby-swift
+
+  Or within your Gemfile if you're using Bundler:
+
+    gem "ruby-swift"
+
+USAGE
+-----
+  Initialize the connection:
+
+```ruby
+swift = RubySwift.new("API_PASSWORD")
+```
+
+  Does a person exist?
+
+```ruby
+swift.person_exists?("you@example.com") # -> true
+```
+
+  Read a person:
+
+```ruby
+person = swift.read_person("you@example.com")
+```
+
+  Add someone to a mail group:
+
+```ruby
+swift.add_group_member("you@example.com", "Group Name") # -> "0"
+```
+
+  Remove someone from a mail group:
+
+```ruby
+swift.remove_group_member("you@example.com", "Group Name") # -> "0"
+```
+
+  Create a person:
+
+```ruby
+swift.write_person(email: "me@example.com", first_name: "Dennis", last_name: "Ritchie") # -> "0"
+```
+
+  Update person:
+
+```ruby
+swift.update_person(email: "you@example.com", first_name: "Donald", last_name: "Knuth") # -> "0"
+```
+
+  Create or update existing person:
+
+```ruby
+swift.write_or_update_person(email: "me@example.com", first_name: "Dennis", last_name: "Ritchie") # -> "0"
+```
+
+  Create a group:
+
+```ruby
+swift.write_group("Group name") # -> "0"
+```
+
+  Read all groups:
+
+```ruby
+groups = swift.read_groups
+```
+
+  Read all members of a group:
+
+```ruby
+people = swift.read_persons("Group Name")
+```
+
+  Remove a group:
+
+```ruby
+swift.remove_group("Group Name") # -> "0"
+```
+
+  Remove a person:
+
+```ruby
+swift.remove_person("you@example.com") # -> "0"
+```
+
+TODO
+----
+  * Tidy up responses (Hashie?)
+  * Return true/false instead of "0" for write actions

data/lib/ruby_swift.rb

@@ -0,0 +1,94 @@
+class RubySwift
+
+  require "savon"
+
+  def initialize(password, namespace="ns1", http_adapter=:net_http)
+    HTTPI.adapter = http_adapter 
+
+    @password = password
+    @client   = Savon.client(endpoint: "http://suite.peoplelogic.com.au/server/includes/apis/soap.php",
+                             namespace: namespace,
+                             convert_request_keys_to: :none)
+  end
+
+  def person_exists?(email)
+    read_person(email).is_a?(Hash)
+  end
+
+  def write_or_update_person(fields)
+    if person_exists?(fields[:email])
+      update_person(fields[:email], fields.reject { |k,v| k == :email})     
+    else
+      write_person(fields)
+    end
+  end
+
+  def read_person(email)
+    soap_request("read_person", {email: email})
+  end
+
+  def write_person(fields)
+    soap_request("write_person", fields)
+  end
+
+  def read_groups
+    soap_request("read_groups")
+  end
+
+  def add_group_member(email, group_name)
+    soap_request("add_group_member", {email: email, group_name: group_name})
+  end
+
+  def remove_group_member(email, group_name)
+    soap_request("remove_group_member", {email: email, group_name: group_name})
+  end
+
+  def read_persons(group_name)
+    soap_request("read_persons", {group_name: group_name})
+  end
+
+  def remove_group(group_name)
+    soap_request("remove_group", {group_name: group_name})
+  end
+
+  def remove_person(email)
+    soap_request("remove_person", {email: email})
+  end
+
+  def update_person(old_email, fields)
+    soap_request("update_person", {email_old: old_email}.merge(fields))
+  end
+
+  def write_group(group_name)
+    soap_request("write_group", {group_name: group_name})
+  end
+
+ private
+
+  # Performs a SOAP request.
+  def soap_request(operation, data=nil)
+    response = @client.call(operation, xml: request_body(operation, data))
+
+    tidy_response(response.body)
+  end
+
+  # Generates a raw XML SOAP request document.
+  # I need to do it this way because the Swift SOAP server expects a particularly weird XML
+  # format that SAvon does not naturally produce.
+  def request_body(operation, data)
+    "<SOAP-ENV:Envelope xmlns:SOAP-ENV=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:ns1=\"urn:pl\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:ns2=\"http://xml.apache.org/xml-soap\" xmlns:SOAP-ENC=\"http://schemas.xmlsoap.org/soap/encoding/\" SOAP-ENV:encodingStyle=\"http://schemas.xmlsoap.org/soap/encoding/\"><SOAP-ENV:Body><ns1:#{operation}><param0 xsi:type=\"xsd:string\">#{@password}</param0><param1 xsi:type=\"ns2:Map\">#{hash_to_soap(data)}</param1></ns1:#{operation}></SOAP-ENV:Body></SOAP-ENV:Envelope>"
+  end
+
+  def hash_to_soap(data)
+    if data
+      data.map do |k, v|
+        "<item><key xsi:type=\"xsd:string\">#{k}</key><value xsi:type=\"xsd:string\">#{v}</value></item>"
+      end.join
+    end
+  end
+
+  # Tidies up the response that Swift gives us.
+  def tidy_response(response)
+    response.to_a[0][1][:return]
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: ruby-swift
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Andrew Buntine
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A ruby wrapper of the Swift Digital Suite Mail House API (https://suite.swiftdigital.com.au).
+email: bunts@hhd.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/ruby_swift.rb
+homepage: http://github.com/buntine/ruby-swift
+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.1
+signing_key: 
+specification_version: 4
+summary: A ruby wrapper of the Swift Digital Suite API.
+test_files: []