ruby-swift 0.1.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e2b51e6f7f50074a4885cf8436c54b83182a17c
-  data.tar.gz: d20f0cdeb344b48e3dec8601af0d21736dc019a8
+  metadata.gz: bcfefd7de34d0ee73b023d387e2fa6572ae1d56d
+  data.tar.gz: 6ba1002f1770ee1219147e6f7e029778e490460d
 SHA512:
-  metadata.gz: 5465aaf43d2e650ae7362e39474a6dbf1c451a2c4c5c8c3b8d3ddd92591b801438d2029221b040dcf026dfb4527038829ab6eb93886dfb77da7daa6518cb493f
-  data.tar.gz: 32a16945bdac5cfb53d2775b57531191e7b578aa9c3a0c77894b2b1ef7687d228b64ccc0fcaa65cdfe6244996455c76b29b36a473f8e32ccdade7f61c392541d
+  metadata.gz: 06981968173bb370b5280fc40b28dd530565ce67607ed05476e1d8cd08c7c53adca491ee65751f1d5aa0175ae6ae6ab31c9716f06ea50d65637b87f5b4d04c53
+  data.tar.gz: 76cb3ab38a76efa4acbe03165dc4c69727a59c4fa0eeec2591bef5e301ad57a7b725cfde92f16882cdae70f926dc17772a18c68e227fa8b876b9565a932abd88

data/README.md

@@ -26,77 +26,75 @@ swift = RubySwift.new("API_PASSWORD")
   Does a person exist?
 
 ```ruby
-swift.person_exists?("you@example.com") # -> true
+swift.person_exists?("you@example.com") # -> {:status => 0, :response => true}
 ```
 
   Read a person:
 
 ```ruby
-person = swift.read_person("you@example.com")
+person = swift.read_person("you@example.com") # -> {:status => 0, :response => {...}}
 ```
 
   Add someone to a mail group:
 
 ```ruby
-swift.add_group_member("you@example.com", "Group Name") # -> "0"
+swift.add_group_member("you@example.com", "Group Name") # -> {:status => 0, :response => true}
 ```
 
   Remove someone from a mail group:
 
 ```ruby
-swift.remove_group_member("you@example.com", "Group Name") # -> "0"
+swift.remove_group_member("you@example.com", "Group Name") # -> {:status => 0, :response => true} 
 ```
 
   Create a person:
 
 ```ruby
-swift.write_person(email: "me@example.com", first_name: "Dennis", last_name: "Ritchie") # -> "0"
+swift.write_person(email: "me@example.com", first_name: "Dennis", last_name: "Ritchie") # -> {:status => 0, :response => true}
 ```
 
   Update person:
 
 ```ruby
-swift.update_person(email: "you@example.com", first_name: "Donald", last_name: "Knuth") # -> "0"
+swift.update_person(email: "you@example.com", first_name: "Donald", last_name: "Knuth") # -> {:status => 0, :response => true}
 ```
 
   Create or update existing person:
 
 ```ruby
-swift.write_or_update_person(email: "me@example.com", first_name: "Dennis", last_name: "Ritchie") # -> "0"
+swift.write_or_update_person(email: "me@example.com", first_name: "Dennis", last_name: "Ritchie") # -> {:status => 0, :response => true}
 ```
 
   Create a group:
 
 ```ruby
-swift.write_group("Group name") # -> "0"
+swift.write_group("Group name") # -> {:status => 0, :response => true}
 ```
 
   Read all groups:
 
 ```ruby
-groups = swift.read_groups
+groups = swift.read_groups # -> {:status => 0, :response => ["group1", "group2", ...]}
 ```
 
   Read all members of a group:
 
 ```ruby
-people = swift.read_persons("Group Name")
+people = swift.read_persons("Group Name") # -> {:status => 0, :response => [{...}, ...]}
 ```
 
   Remove a group:
 
 ```ruby
-swift.remove_group("Group Name") # -> "0"
+swift.remove_group("Group Name") # -> {:status => 0, :response => true}
 ```
 
   Remove a person:
 
 ```ruby
-swift.remove_person("you@example.com") # -> "0"
+swift.remove_person("you@example.com") # -> {:status => 0, :response => true}
 ```
 
 TODO
 ----
-  * Tidy up responses (Hashie?)
-  * Return true/false instead of "0" for write actions
   * Allow custom fields in write/update

data/lib/ruby-swift.rb

@@ -12,7 +12,7 @@ class RubySwift
   end
 
   def person_exists?(email)
-    read_person(email).is_a?(Hash)
+    read_person(email)[:status] == 0
   end
 
   def write_or_update_person(fields)
@@ -24,43 +24,53 @@ class RubySwift
   end
 
   def read_person(email)
-    soap_request("read_person", {email: email})
+    return_response(soap_request("read_person", {email: email})) do |sr|
+      convert_to_person(sr)
+    end
   end
 
   def write_person(fields)
-    soap_request("write_person", fields)
+    return_response(soap_request("write_person", fields))
   end
 
   def read_groups
-    soap_request("read_groups")
+    return_response(soap_request("read_groups")) do |sr|
+      sr[:item].map do |group|
+        group[:item][:value]
+      end
+    end
   end
 
   def add_group_member(email, group_name)
-    soap_request("add_group_member", {email: email, group_name: group_name})
+    return_response(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})
+    return_response(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})
+    return_response(soap_request("read_persons", {group_name: group_name})) do |sr|
+      sr[:item].map do |person|
+        convert_to_person(person)
+      end
+    end
   end
 
   def remove_group(group_name)
-    soap_request("remove_group", {group_name: group_name})
+    return_response(soap_request("remove_group", {group_name: group_name}))
   end
 
   def remove_person(email)
-    soap_request("remove_person", {email: email})
+    return_response(soap_request("remove_person", {group_name: group_name}))
   end
 
   def update_person(old_email, fields)
-    soap_request("update_person", {email_old: old_email}.merge(fields))
+    return_response(soap_request("update_person", {email_old: old_email}.merge(fields)))
   end
 
   def write_group(group_name)
-    soap_request("write_group", {group_name: group_name})
+    return_response(soap_request("write_group", {group_name: group_name}))
   end
 
  private
@@ -91,4 +101,23 @@ class RubySwift
   def tidy_response(response)
     response.to_a[0][1][:return]
   end
+
+  def convert_to_person(soap_response)
+    Hash[*soap_response[:item].map { |line|
+      [line[:key].to_sym, (line[:value].is_a? Hash) ? nil : line[:value]]
+    }.flatten]
+  end
+
+  def return_response(soap_response, &block)
+    status = soap_response.to_s.to_i
+    resp = if status == 0
+      if block_given?
+        yield soap_response
+      else
+        true
+      end
+    end
+
+    return {:status => status, :response => resp}
+  end
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: ruby-swift
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Andrew Buntine
+- Philip Castiglione
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-16 00:00:00.000000000 Z
+date: 2015-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
@@ -53,7 +54,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: A ruby wrapper of the Swift Digital Suite API.