action_kit_api 0.1.5 → 0.1.6

data/lib/action_kit_api/connection.rb

@@ -1,23 +1,23 @@
 require 'xmlrpc/client'
 
-# This file adds the connection information for the ActionKit API
-# which is used throughout the rest of the Gem (a connection being
-# required for ... well every operation ... this is a remote API
-# gem :)
-
-# This seems silly and dangerous right? Overwriting something in the ruby
-# standard libraries? Well ActionKit is doing XMLRPC wrong. This is almost
-# identical to the Ruby standard library version however it drops the type
-# check on the faultCode and the faultString. The XMLRPC standard indicates
-# that yes the faultCode has to be an integer and faultString has to be a
-# string. ActionKit WILL RETURN A STRING AS THE faultCode.
-#
-# References:
-#   XMLRPC Spec:
-#     http://xmlrpc.scripting.com/spec.html
-#   ActionKit (just an example, see second sentence under 'get'
-#     https://roboticdogs.actionkit.com/docs/manual/api/users.html?highlight=faultcode
 module XMLRPC
+  # This file adds the connection information for the ActionKit API
+  # which is used throughout the rest of the Gem (a connection being
+  # required for ... well every operation ... this is a remote API
+  # gem :)
+
+  # This seems silly and dangerous right? Overwriting something in the ruby
+  # standard libraries? Well ActionKit is doing XMLRPC wrong. This is almost
+  # identical to the Ruby standard library version however it drops the type
+  # check on the faultCode and the faultString. The XMLRPC standard indicates
+  # that yes the faultCode has to be an integer and faultString has to be a
+  # string. ActionKit WILL RETURN A STRING AS THE faultCode.
+  #
+  # References:
+  #   XMLRPC Spec:
+  #     http://xmlrpc.scripting.com/spec.html
+  #   ActionKit (just an example, see second sentence under 'get'
+  #     https://roboticdogs.actionkit.com/docs/manual/api/users.html?highlight=faultcode
   module Convert 
     def self.fault(hash)
       if hash.kind_of? Hash and hash.size == 2 and
@@ -29,6 +29,13 @@ module XMLRPC
       end
     end
   end
+
+  # We're overriding the user agent to make these requests more obviously
+  # from this wrapper
+  class Client
+    remove_const(:USER_AGENT)
+    USER_AGENT = "DFA Ruby action_kit_api/#{ActionKitApi::VERSION} ( http://code.democracyforamerica.com/ )"
+  end
 end
 
 module ActionKitApi
@@ -69,13 +76,10 @@ module ActionKitApi
       raise NoConnection if @@connection.nil?
 
       # XMLRPC::Client doesn't flush it's IO buffer which occasionally
-      # causes a second command in the same session to fail with an EOFError
-      # calling it again after that will actually execute the command
-      begin
-        @@connection.call(command, args)
-      rescue EOFError
-        @@connection.call(command, args)
-      end
+      # causes a second command on the same connection to fail with an
+      # EOFError. Using the _async version of this causes XMLRPC::Client
+      # to use a new connection each time eliminating this issue
+      @@connection.call_async(command, args)
     end
 
     def self.version

data/lib/action_kit_api/data_model.rb

@@ -5,7 +5,6 @@ module ActionKitApi
   end
 
   class ApiDataModel
-
     def initialize(hash = {})
       @required_attrs = []
 
@@ -57,6 +56,11 @@ module ActionKitApi
         user_hash[key] = self.instance_variable_get(iv)
       end
 
+      # XMLRPC::Client doesn't like empty values
+      user_hash.delete_if do |k, v|
+        v.to_s.empty?
+      end
+
       user_hash
     end
   end 

data/lib/action_kit_api/searchable.rb

@@ -22,7 +22,7 @@ module ActionKitApi
         # Get the name of the class that this module has been mixed into
         class_name = self.to_s.split("::").last
 
-        search = parse_attributes(attrs, args)
+        search = self.parse_attributes(attrs, args)
 
         begin
           response = ActionKitApi::Connection.call("#{class_name}.get", search)
@@ -48,11 +48,11 @@ module ActionKitApi
         # Get the name of the class that this module has been mixed into
         class_name = self.to_s.split("::").last
 
-        search = parse_attributes(attrs, args)
+        search = self.parse_attributes(attrs, args)
         
         # For when I get to retrieving all results, through pagination
         # Would be a good candidate for yielding (probably in batches of 50-100)
-        #response_count = ActionKitApi::Connection.call("#{class_name}.count", search)
+        #response_count = self.count(search)
         search["limit"] = 1000
         #search["offset"] = 0
 
@@ -66,6 +66,10 @@ module ActionKitApi
         response_objects
       end
 
+      def class_name.count(search)
+        ActionKitApi::Connection.call("#{class_name}.count", search)
+      end
+
       # Helper method for method_missing and the find_* virtual methods that
       # parses part of a method name and arguments into a hash usuable for the
       # API calls

data/lib/action_kit_api/version.rb

@@ -1,3 +1,3 @@
 module ActionKitApi
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

data/lib/action_kit_api.rb

@@ -1,4 +1,5 @@
 # These are the primary portions of the API wrapper runtime
+require "action_kit_api/version"
 require "action_kit_api/connection"
 require "action_kit_api/searchable"
 require "action_kit_api/data_model"

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 5
-  version: 0.1.5
+  - 6
+  version: 0.1.6
 platform: ruby
 authors: 
 - Sam Stelfox
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-02-23 00:00:00 -05:00
+date: 2012-02-24 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency