your_membership 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c93432ed686e1f80df9f1d4fa5d33eb38785b02b
-  data.tar.gz: dffe41b0e69376c7669a30b184a76c405e3b2751
+  metadata.gz: a2114fa42d26afb1c73747800e9aba7e90513d97
+  data.tar.gz: bf1322fe1e0c1e8493b90d082062ae4e0d8af826
 SHA512:
-  metadata.gz: d7dae1c53e40a3d2c24d7dc8715a07c7fa41c917b316ed4b33afe3cb13239ea647e977b3bbead6bc42d1c48850d60fb6afec4620f14c552148db055c44fb2eb7
-  data.tar.gz: 1668ab62de7584be9e23d67016560b36c8bda85e9fcd36a9b40f40f421d5e26bf529991eb8cae686418ed55057a6645ffe49a4b75607b13ffeab9cb8d8b31a60
+  metadata.gz: 58f41d9ba44581eb27c2e97d0927766fd21c6ca6772a098a44962b9f084c71b5f5c85c3cdb73afa32a6f7d9b71af7c4de88ae358c183754b30d0c5c5a363517c
+  data.tar.gz: 524ff0de4cc6d178a4e2823ed316e8a928768fcfcda3f4134d60ae9e9a0a8b93236626d6d703e5c317e46347a950e60cb43304a43ee63d00cacfeef751a57eea

data/.env

@@ -0,0 +1,5 @@
+# Copy this file to .env.local and add your keys if you need to test against
+# the real API.
+YM_API_PUBLIC_KEY: redacted
+YM_API_PRIVATE_KEY: redacted
+YM_API_SA_PASSCODE: redacted

data/.gitignore

@@ -2,6 +2,7 @@
 *.rbc
 .bundle
 .config
+.env.local
 .yardoc
 Gemfile.lock
 InstalledFiles

data/.rspec

@@ -0,0 +1 @@
+--color

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased]
+
+## [1.1.1] - 2016-03-23
+### Fixed
+- Crash in `Profile#parse_custom_field_responses` when there are no
+  CustomFieldResponses present.

data/README.md

@@ -23,7 +23,7 @@ Or install it yourself as:
 
 ## Usage
 
-Every effort has been made to expose the YourMembership.com API as transparently as possible while still providing a natively Ruby interface. 
+Every effort has been made to expose the YourMembership.com API as transparently as possible while still providing a natively Ruby interface.
 
 ### Scope and Naming
 
@@ -94,7 +94,7 @@ You can pass strings as keys if you do not prefer to use Symbols.
 
 ##### SDK-Specific Implementation of Argument Types
 
-You should use the standard Ruby types to represent data, for instance: 
+You should use the standard Ruby types to represent data, for instance:
 
 `:Timestamp` and other date or time arguments should be passed as DateTime objects rather than formatted strings, the formatting will be done for you.
 
@@ -104,7 +104,7 @@ You should use the standard Ruby types to represent data, for instance:
 
 #### Returned Values
 
-The SDK translates the returned data into Ruby Objects of only a few types. Nearly all methods return an Array, this may be an Array of Strings or, more likely, it will be an Array of Hashes. 
+The SDK translates the returned data into Ruby Objects of only a few types. Nearly all methods return an Array, this may be an Array of Strings or, more likely, it will be an Array of Hashes.
 
 If only a single record can ever be retrieved at a time through a method a Hash object will be returned instead of an Array.
 
@@ -162,7 +162,7 @@ The Member object builds upon the Session object to more fully represent an auth
 ##### Instantiation:
 ```RUBY
 # Members can be created by authenticating directly with the YourMembership API,
-# the session is automatically created and bound to the Member instance. 
+# the session is automatically created and bound to the Member instance.
 member = YourMembership::Member.create_by_authentication 'username', 'password'
 
 # Members can also be created by passing in an already existing Session instance
@@ -213,7 +213,7 @@ An *outdated* list of standard fields can be found here: https://api.yourmembers
 
 ##### Data Access
 + **Profile#data** `Hash` This internal hash can be read and written to and should contain only fields that are standard in the YourMembership system.
-+ **Profile#custom_data** `Hash` This internal hash can be read and written to and should contain the fields that are specified as custom responses in a specific YourMembership community. 
++ **Profile#custom_data** `Hash` This internal hash can be read and written to and should contain the fields that are specified as custom responses in a specific YourMembership community.
 + **Profile#to_h** `Hash` is a read-only method for returning a single nested hash of both standard and custom fields.
 
 #### YourMembership::Export
@@ -238,7 +238,7 @@ when :complete
 	# Export is ready
 	donations.export_uri
 end
-``` 
+```
 
 ## About The Author(s)
 
@@ -259,7 +259,9 @@ If you find a problem with this library or would like to contribute an improveme
 If you're a developer that would like to help solve world hunger problems with some of your spare time, we are always looking for talented volunteers. Contact Nate Flood by email: nate [at] echonet [dot] org
 
 1. Fork it ( https://github.com/ECHOInternational/your_membership/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+2. If you need to make real API calls while testing, see the .env file
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Ensure the specs pass (`bundle exec rspec`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create a new Pull Request

data/lib/httparty/patch.rb

@@ -1,33 +1,33 @@
-require 'cgi'
-
-# Monkey Patch for the HTTParty Gem
-module HTTParty
-  # In order to parse the HTML encoded documents returned by the YourMembership
-  # API we need to HTML decode the <![CDATA[ tags. This is a bug workaround.
-  class Request
-    # This is the encode_body method from HTTParty's Request Class adding an additional method call to fix
-    # the CDATA elements that are improperly formatted in the YourMembership API's XML. This is done here to ensure that
-    # the fix is in place before the data is parsed.
-    def encode_body(body)
-      body = fix_cdata body
-      if ''.respond_to?(:encoding)
-        _encode_body(body)
-      else
-        body
-      end
-    end
-
-    # Bug Fix for HTML encoded < and > in XML body.
-    # @param body [String] an XML document that needs to be checked for this specific issue.
-    # @return [String] If the HTML encoding issue is found it is repaired and the document is returned.
-    def fix_cdata(body)
-      # <![CDATA[ = &lt;![CDATA[
-      # ]]> =  ]]&gt;
-      if body.include? '&lt;![CDATA['
-        body.gsub! '&lt;![CDATA[', '<![CDATA['
-        body.gsub! ']]&gt', ']]>'
-      end
-      body
-    end
-  end
-end
+require 'cgi'
+
+# Monkey Patch for the HTTParty Gem
+module HTTParty
+  # In order to parse the HTML encoded documents returned by the YourMembership
+  # API we need to HTML decode the <![CDATA[ tags. This is a bug workaround.
+  class Request
+    # This is the encode_body method from HTTParty's Request Class adding an additional method call to fix
+    # the CDATA elements that are improperly formatted in the YourMembership API's XML. This is done here to ensure that
+    # the fix is in place before the data is parsed.
+    def encode_body(body)
+      body = fix_cdata body
+      if ''.respond_to?(:encoding)
+        _encode_body(body)
+      else
+        body
+      end
+    end
+
+    # Bug Fix for HTML encoded < and > in XML body.
+    # @param body [String] an XML document that needs to be checked for this specific issue.
+    # @return [String] If the HTML encoding issue is found it is repaired and the document is returned.
+    def fix_cdata(body)
+      # <![CDATA[ = &lt;![CDATA[
+      # ]]> =  ]]&gt;
+      if body.include? '&lt;![CDATA['
+        body.gsub! '&lt;![CDATA[', '<![CDATA['
+        body.gsub! ']]&gt', ']]>'
+      end
+      body
+    end
+  end
+end

data/lib/your_membership/base.rb

@@ -1,197 +1,197 @@
-module YourMembership
-  # Base Class inherited by all Your Membership SDK Classes.
-  class Base
-    include HTTParty
-
-    base_uri YourMembership.config[:baseUri]
-
-    # rubocop:disable Style/ClassVars
-
-    # Call IDs are usually tied to sessions, this is a unique call id for use whenever a session is not needed.
-    @@genericCallID = nil
-
-    # @return [Integer] Auto Increments ad returns the genericCallID as required by the YourMembership.com API
-    def self.new_call_id
-      if @@genericCallID.nil?
-        # We start with a very high number to avoid conflicts when initiating a new session.
-        @@genericCallID = 10_000
-      else
-        @@genericCallID += 1
-      end
-      @@genericCallID
-    end
-    # rubocop:enable Style/ClassVars
-
-    # A Guard Method that returns true if the response from the API can be processed and raises an exception if not.
-    # @param [Hash] response
-    # @return [Boolean] true if no errors found.
-    # @raise [HTTParty::ResponseError] if a communication error is found.
-    def self.response_valid?(response)
-      if response.success?
-        !response_ym_error?(response)
-      else
-        raise HTTParty::ResponseError.new(response), 'Connection to YourMembership API failed.'
-      end
-    end
-
-    # Checks for error codes in the API response and raises an exception if an error is found.
-    # @param [Hash] response
-    # @return [Boolean] false if no error is found
-    # @raise [YourMembership::Error] if an error is found
-    def self.response_ym_error?(response)
-      if response['YourMembership_Response']['ErrCode'] != '0'
-        raise YourMembership::Error.new(
-          response['YourMembership_Response']['ErrCode'],
-          response['YourMembership_Response']['ErrDesc']
-        )
-      else
-        return false
-      end
-    end
-
-    # Creates an XML string to send to the API
-    # @todo THIS SHOULD BE MARKED PRIVATE and refactored to DRY up the calls.
-    def self.build_XML_request(callMethod, session = nil, params = {}) # rubocop:disable Style/MethodLength, Style/MethodName
-      builder = Nokogiri::XML::Builder.new(:encoding => 'UTF-8') do |xml|
-        # Root Node Is always <YourMembership>
-        xml.YourMembership do
-          # API Version
-          xml.Version_ YourMembership.config[:version]
-
-          # API Key: For System Administrative tasks it is the private key and
-          # passcode, for all others it is the public key
-          if callMethod.downcase.start_with?('sa.')
-            xml.ApiKey_ YourMembership.config[:privateKey]
-            xml.SaPasscode_ YourMembership.config[:saPasscode]
-          else
-            xml.ApiKey_ YourMembership.config[:publicKey]
-          end
-
-          # Pass Session ID and Session Call ID unless there is no session, then
-          # send call id from class
-          if session
-            if session.is_a? YourMembership::Session
-              xml.SessionID_ session.session_id
-            else
-              xml.SessionID_ session
-            end
-            xml.CallID_ session.call_id
-          else
-            xml.CallID_ new_call_id
-          end
-
-          xml.Call(:Method => callMethod) do
-            params.each do |key, value|
-              xml_process(key, value, xml)
-            end
-          end
-        end
-      end
-
-      builder.to_xml
-    end
-
-    # This is a helper method to always return an array (potentially empty) of responses (Hashes) for methods that can
-    # have multiple results. The default behavior of the API is to return a nil if no records are found, a hash if one
-    # record is found and an array if multiple records are found.
-    #
-    # @param [Hash] response_body This is the nodeset that returns nil if an empty data set is returned.
-    # @param [Array] keys This is a list of keys, in order that are nested inside the response body, these keys will be
-    #  traversed in order before retrieving the data associated with the last key in the array
-    # @return [Array] A single dimension array of hashes.
-    def self.response_to_array_of_hashes(response_body, keys = [])
-      return_array = []
-      if  response_body
-        # http://stackoverflow.com/questions/13259181/what-is-the-most-ruby-ish-way-of-accessing-nested-hash-values-at-arbitrary-depth
-        response_body_items = keys.reduce(response_body) { |h, key| h[key] }
-        if response_body_items.class == Array
-          response_body_items.each do |response_item|
-            return_array.push response_item
-          end
-        else
-          return_array.push response_body_items
-        end
-      end
-      return_array
-    end
-
-    # Converts the desired portion of the XML response to a single dimension array.
-    # This is useful when you don't have a need for key, value pairs and want a clean array of values to work with.
-    #
-    # @param [Hash] response_body This is the nodeset that returns nil if an empty data set is returned.
-    # @param [Array] keys This is a list of keys, in order that are nested inside the response body, these keys will be
-    #  traversed in order before retrieving the data associated with the key_for_array
-    # @param [String] key_for_array this is the key that represents the list of items you want to turn into an array.
-    # @return [Array] A single dimension array of values.
-    def self.response_to_array(response_body, keys = [], key_for_array)
-      return_array = []
-      response_hash_array = response_to_array_of_hashes(response_body, keys)
-      response_hash_array.each do |item|
-        return_array.push item[key_for_array]
-      end
-      return_array
-    end
-
-    private
-
-    # Convenience method to convert Ruby DateTime objects into ODBC canonical strings as are expected by the API
-    # @param [DateTime] dateTime
-    # @return [String] An ODBC canonical string representation of a date as is expected by the API
-    def self.format_date_string(dateTime)
-      dateTime.strftime('%Y-%m-%d %H:%M:%S')
-    end
-
-    def self.xml_process(key, value, xml)
-      case value
-      when Array
-        xml_process_array(key, value, xml)
-      when Hash
-        xml_process_hash(key, value, xml)
-      when YourMembership::Profile
-        xml_process_profile(value, xml)
-      when DateTime
-        xml.send(key, format_date_string(value))
-      else
-        xml.send(key, value)
-      end
-    end
-
-    def self.xml_process_profile(profile, xml)
-      profile.data.each do |k, v|
-        xml_process(k, v, xml)
-      end
-      xml.send('CustomFieldResponses') do
-        profile.custom_data.each do |k, v|
-          xml_process_custom_field_responses(k, v, xml)
-        end
-      end
-    end
-
-    def self.xml_process_hash(key, value, xml)
-      xml.send(key) do
-        value.each { |k, v| xml_process(k, v, xml) }
-      end
-    end
-
-    def self.xml_process_array(key, value, xml)
-      xml.send(key) do
-        value.each { |tag| xml.send(tag[0], tag[1]) }
-      end
-    end
-
-    def self.xml_process_custom_field_responses(key, value, xml)
-      xml.send('CustomFieldResponse', :FieldCode => key) do
-        xml.send('Values') do
-          case value
-          when Array
-            value.each do | item |
-              xml.send('Value', item)
-            end
-          else
-            xml.send('Value', value)
-          end
-        end
-      end
-    end
-  end
-end
+module YourMembership
+  # Base Class inherited by all Your Membership SDK Classes.
+  class Base
+    include HTTParty
+
+    base_uri YourMembership.config[:baseUri]
+
+    # rubocop:disable Style/ClassVars
+
+    # Call IDs are usually tied to sessions, this is a unique call id for use whenever a session is not needed.
+    @@genericCallID = nil
+
+    # @return [Integer] Auto Increments ad returns the genericCallID as required by the YourMembership.com API
+    def self.new_call_id
+      if @@genericCallID.nil?
+        # We start with a very high number to avoid conflicts when initiating a new session.
+        @@genericCallID = 10_000
+      else
+        @@genericCallID += 1
+      end
+      @@genericCallID
+    end
+    # rubocop:enable Style/ClassVars
+
+    # A Guard Method that returns true if the response from the API can be processed and raises an exception if not.
+    # @param [Hash] response
+    # @return [Boolean] true if no errors found.
+    # @raise [HTTParty::ResponseError] if a communication error is found.
+    def self.response_valid?(response)
+      if response.success?
+        !response_ym_error?(response)
+      else
+        raise HTTParty::ResponseError.new(response), 'Connection to YourMembership API failed.'
+      end
+    end
+
+    # Checks for error codes in the API response and raises an exception if an error is found.
+    # @param [Hash] response
+    # @return [Boolean] false if no error is found
+    # @raise [YourMembership::Error] if an error is found
+    def self.response_ym_error?(response)
+      if response['YourMembership_Response']['ErrCode'] != '0'
+        raise YourMembership::Error.new(
+          response['YourMembership_Response']['ErrCode'],
+          response['YourMembership_Response']['ErrDesc']
+        )
+      else
+        return false
+      end
+    end
+
+    # Creates an XML string to send to the API
+    # @todo THIS SHOULD BE MARKED PRIVATE and refactored to DRY up the calls.
+    def self.build_XML_request(callMethod, session = nil, params = {}) # rubocop:disable Style/MethodLength, Style/MethodName
+      builder = Nokogiri::XML::Builder.new(:encoding => 'UTF-8') do |xml|
+        # Root Node Is always <YourMembership>
+        xml.YourMembership do
+          # API Version
+          xml.Version_ YourMembership.config[:version]
+
+          # API Key: For System Administrative tasks it is the private key and
+          # passcode, for all others it is the public key
+          if callMethod.downcase.start_with?('sa.')
+            xml.ApiKey_ YourMembership.config[:privateKey]
+            xml.SaPasscode_ YourMembership.config[:saPasscode]
+          else
+            xml.ApiKey_ YourMembership.config[:publicKey]
+          end
+
+          # Pass Session ID and Session Call ID unless there is no session, then
+          # send call id from class
+          if session
+            if session.is_a? YourMembership::Session
+              xml.SessionID_ session.session_id
+            else
+              xml.SessionID_ session
+            end
+            xml.CallID_ session.call_id
+          else
+            xml.CallID_ new_call_id
+          end
+
+          xml.Call(:Method => callMethod) do
+            params.each do |key, value|
+              xml_process(key, value, xml)
+            end
+          end
+        end
+      end
+
+      builder.to_xml
+    end
+
+    # This is a helper method to always return an array (potentially empty) of responses (Hashes) for methods that can
+    # have multiple results. The default behavior of the API is to return a nil if no records are found, a hash if one
+    # record is found and an array if multiple records are found.
+    #
+    # @param [Hash] response_body This is the nodeset that returns nil if an empty data set is returned.
+    # @param [Array] keys This is a list of keys, in order that are nested inside the response body, these keys will be
+    #  traversed in order before retrieving the data associated with the last key in the array
+    # @return [Array] A single dimension array of hashes.
+    def self.response_to_array_of_hashes(response_body, keys = [])
+      return_array = []
+      if  response_body
+        # http://stackoverflow.com/questions/13259181/what-is-the-most-ruby-ish-way-of-accessing-nested-hash-values-at-arbitrary-depth
+        response_body_items = keys.reduce(response_body) { |h, key| h[key] }
+        if response_body_items.class == Array
+          response_body_items.each do |response_item|
+            return_array.push response_item
+          end
+        else
+          return_array.push response_body_items
+        end
+      end
+      return_array
+    end
+
+    # Converts the desired portion of the XML response to a single dimension array.
+    # This is useful when you don't have a need for key, value pairs and want a clean array of values to work with.
+    #
+    # @param [Hash] response_body This is the nodeset that returns nil if an empty data set is returned.
+    # @param [Array] keys This is a list of keys, in order that are nested inside the response body, these keys will be
+    #  traversed in order before retrieving the data associated with the key_for_array
+    # @param [String] key_for_array this is the key that represents the list of items you want to turn into an array.
+    # @return [Array] A single dimension array of values.
+    def self.response_to_array(response_body, keys = [], key_for_array)
+      return_array = []
+      response_hash_array = response_to_array_of_hashes(response_body, keys)
+      response_hash_array.each do |item|
+        return_array.push item[key_for_array]
+      end
+      return_array
+    end
+
+    private
+
+    # Convenience method to convert Ruby DateTime objects into ODBC canonical strings as are expected by the API
+    # @param [DateTime] dateTime
+    # @return [String] An ODBC canonical string representation of a date as is expected by the API
+    def self.format_date_string(dateTime)
+      dateTime.strftime('%Y-%m-%d %H:%M:%S')
+    end
+
+    def self.xml_process(key, value, xml)
+      case value
+      when Array
+        xml_process_array(key, value, xml)
+      when Hash
+        xml_process_hash(key, value, xml)
+      when YourMembership::Profile
+        xml_process_profile(value, xml)
+      when DateTime
+        xml.send(key, format_date_string(value))
+      else
+        xml.send(key, value)
+      end
+    end
+
+    def self.xml_process_profile(profile, xml)
+      profile.data.each do |k, v|
+        xml_process(k, v, xml)
+      end
+      xml.send('CustomFieldResponses') do
+        profile.custom_data.each do |k, v|
+          xml_process_custom_field_responses(k, v, xml)
+        end
+      end
+    end
+
+    def self.xml_process_hash(key, value, xml)
+      xml.send(key) do
+        value.each { |k, v| xml_process(k, v, xml) }
+      end
+    end
+
+    def self.xml_process_array(key, value, xml)
+      xml.send(key) do
+        value.each { |tag| xml.send(tag[0], tag[1]) }
+      end
+    end
+
+    def self.xml_process_custom_field_responses(key, value, xml)
+      xml.send('CustomFieldResponse', :FieldCode => key) do
+        xml.send('Values') do
+          case value
+          when Array
+            value.each do | item |
+              xml.send('Value', item)
+            end
+          else
+            xml.send('Value', value)
+          end
+        end
+      end
+    end
+  end
+end