your_membership 1.1.0 → 1.1.1

data/lib/your_membership/members.rb

@@ -1,124 +1,124 @@
-module YourMembership
-  # YourMembership Members Namespace
-  class Members < YourMembership::Base
-    # Returns a member's connection category list.
-    #
-    # @see https://api.yourmembership.com/reference/2_00/Members_Connections_Categories_Get.htm
-    #
-    # @param [YourMembership::Session] session
-    # @param [String] member_id or ProfileID of the member's connections to get.
-    # @return [Array] Returns an Array of Hashes representing a member's connection categories.
-    # @note If you attempt to retrieve a member's connection category list and they have not assigned any connections to
-    #  categories an execption of type 406 from YourMembership.com 'Method could not uniquely identify a record on which
-    #  to operate' will be raised.
-    def self.connections_categories_get(session, member_id)
-      options = {}
-      options[:ID] = member_id
-      response = post('/', :body => build_XML_request('Members.Connections.Categories.Get', session, options))
-
-      response_valid? response
-      response_to_array_of_hashes response['YourMembership_Response']['Members.Connections.Categories.Get'], ['Category']
-    end
-
-    # Returns a member's connection list, optionally filtered by category. Returns a maximum of 100 records per request.
-    #
-    # @see https://api.yourmembership.com/reference/2_00/Members_Connections_Get.htm
-    #
-    # @param [YourMembership::Session] session
-    # @param [String] member_id or ProfileID of the member's connections to get.
-    # @param [Hash] options
-    # @option options [Integer] :CategoryID Filter the returned results by connection category.
-    # @option options [Integer] :PageSize The maximum number of records in the returned result set.
-    # @option options [Integer] :StartRecord The record number at which to start the returned result set.
-    # @return [Array] Returns an Array of Hashes representing a member's connections.
-    def self.connections_get(session, member_id, options = {})
-      options = {}
-      options[:ID] = member_id
-      response = post('/', :body => build_XML_request('Members.Connections.Get', session, options))
-
-      response_valid? response
-      response_to_array_of_hashes response['YourMembership_Response']['Members.Connections.Get'], ['Connection']
-    end
-
-    # Returns a member's media gallery album list. The returned list will include <AlbumID>-1</AlbumID> which is a
-    # virtual album containing all of the member's media gallery items.
-    #
-    # @see https://api.yourmembership.com/reference/2_00/Members_MediaGallery_Albums_Get.htm
-    #
-    # @param [YourMembership::Session] session
-    # @param [String] member_id or ProfileID of the member whose media gallery albums to return.
-    # @return [Array] Returns an Array of Hashes representing a member's albums.
-    # @note BUG NOTED - This method seems to raise an exception on every call saying that Method Call Failed one or more
-    #  elements is missing or invalid
-    # @todo Contact YourMembership.com dev team to see if we're doing this correctly.
-    def self.mediaGallery_albums_get(session, member_id) # rubocop:disable Style/MethodName
-      options = {}
-      options[:ID] = member_id
-      # puts build_XML_request('Members.MediaGallery.Albums.Get', session, options)
-      response = post('/', :body => build_XML_request('Members.MediaGallery.Albums.Get', session, options))
-
-      response_valid? response
-      response_to_array_of_hashes response['YourMembership_Response']['Members.MediaGallery.Albums.Get'], ['Album']
-    end
-
-    # Returns a member's media gallery item list, optionally filtered by album. Returns a maximum of 100 records per
-    # request.
-    #
-    # @see https://api.yourmembership.com/reference/2_00/Members_MediaGallery_Get.htm
-    #
-    # @param [YourMembership::Session] session
-    # @param [String] member_id or ProfileID of the member whose media gallery to retrieve.
-    # @param [Hash] options
-    # @option options [String] :AlbumID Filter the returned results by media gallery album.
-    # @option options [Integer] :PageSize The maximum number of records in the returned result set.
-    # @option options [Integer] :StartRecord The record number at which to start the returned result set.
-    # @return [Array] Returns an Array of Hashes representing a member's media items.
-    # @note If you attempt to retrieve a member's gallery item list and they have no media an exception will be thrown
-    #  of type 406 from YourMembership.com 'Method could not uniquely identify a record on which to operate'
-    def self.mediaGallery_get(session, member_id, options = {}) # rubocop:disable Style/MethodName
-      options = {}
-      options[:ID] = member_id
-      response = post('/', :body => build_XML_request('Members.MediaGallery.Get', session, options))
-
-      response_valid? response
-      response_to_array_of_hashes response['YourMembership_Response']['Members.MediaGallery.Get'], ['Item']
-    end
-
-    # Returns a single media gallery item.
-    #
-    # @see https://api.yourmembership.com/reference/2_00/Members_MediaGallery_Item_Get.htm
-    #
-    # @param [YourMembership::Session] session
-    # @param [String] member_id or ProfileID of the member whose media gallery item to return.
-    # @param [Integer] item_id of the media gallery item to return.
-    # @return [Hash] Returns an Hash that represents a single media item.
-    def self.mediaGallery_item_get(session, member_id, item_id) # rubocop:disable Style/MethodName
-      options = {}
-      options[:ID] = member_id
-      options[:ItemID] = item_id
-      response = post('/', :body => build_XML_request('Members.MediaGallery.Item.Get', session, options))
-
-      response_valid? response
-      response['YourMembership_Response']['Members.MediaGallery.Item.Get']
-    end
-
-    # Returns a member's wall.
-    #
-    # @see https://api.yourmembership.com/reference/2_00/Members_Wall_Get.htm
-    #
-    # @param [YourMembership::Session] session
-    # @param [String] member_id ID or ProfileID of the member's wall to get.
-    # @param [Hash] options
-    # @option options [Integer] :PageSize The maximum number of records in the returned result set.
-    # @option options [Integer] :StartRecord The record number at which to start the returned result set.
-    # @return [Hash] Returns a Hash representing the requested user's wall.
-    def self.wall_get(session, member_id, options = {})
-      options = {}
-      options[:ID] = member_id
-      response = post('/', :body => build_XML_request('Members.Wall.Get', session, options))
-
-      response_valid? response
-      response['YourMembership_Response']['Members.Wall.Get']
-    end
-  end
-end
+module YourMembership
+  # YourMembership Members Namespace
+  class Members < YourMembership::Base
+    # Returns a member's connection category list.
+    #
+    # @see https://api.yourmembership.com/reference/2_00/Members_Connections_Categories_Get.htm
+    #
+    # @param [YourMembership::Session] session
+    # @param [String] member_id or ProfileID of the member's connections to get.
+    # @return [Array] Returns an Array of Hashes representing a member's connection categories.
+    # @note If you attempt to retrieve a member's connection category list and they have not assigned any connections to
+    #  categories an execption of type 406 from YourMembership.com 'Method could not uniquely identify a record on which
+    #  to operate' will be raised.
+    def self.connections_categories_get(session, member_id)
+      options = {}
+      options[:ID] = member_id
+      response = post('/', :body => build_XML_request('Members.Connections.Categories.Get', session, options))
+
+      response_valid? response
+      response_to_array_of_hashes response['YourMembership_Response']['Members.Connections.Categories.Get'], ['Category']
+    end
+
+    # Returns a member's connection list, optionally filtered by category. Returns a maximum of 100 records per request.
+    #
+    # @see https://api.yourmembership.com/reference/2_00/Members_Connections_Get.htm
+    #
+    # @param [YourMembership::Session] session
+    # @param [String] member_id or ProfileID of the member's connections to get.
+    # @param [Hash] options
+    # @option options [Integer] :CategoryID Filter the returned results by connection category.
+    # @option options [Integer] :PageSize The maximum number of records in the returned result set.
+    # @option options [Integer] :StartRecord The record number at which to start the returned result set.
+    # @return [Array] Returns an Array of Hashes representing a member's connections.
+    def self.connections_get(session, member_id, options = {})
+      options = {}
+      options[:ID] = member_id
+      response = post('/', :body => build_XML_request('Members.Connections.Get', session, options))
+
+      response_valid? response
+      response_to_array_of_hashes response['YourMembership_Response']['Members.Connections.Get'], ['Connection']
+    end
+
+    # Returns a member's media gallery album list. The returned list will include <AlbumID>-1</AlbumID> which is a
+    # virtual album containing all of the member's media gallery items.
+    #
+    # @see https://api.yourmembership.com/reference/2_00/Members_MediaGallery_Albums_Get.htm
+    #
+    # @param [YourMembership::Session] session
+    # @param [String] member_id or ProfileID of the member whose media gallery albums to return.
+    # @return [Array] Returns an Array of Hashes representing a member's albums.
+    # @note BUG NOTED - This method seems to raise an exception on every call saying that Method Call Failed one or more
+    #  elements is missing or invalid
+    # @todo Contact YourMembership.com dev team to see if we're doing this correctly.
+    def self.mediaGallery_albums_get(session, member_id) # rubocop:disable Style/MethodName
+      options = {}
+      options[:ID] = member_id
+      # puts build_XML_request('Members.MediaGallery.Albums.Get', session, options)
+      response = post('/', :body => build_XML_request('Members.MediaGallery.Albums.Get', session, options))
+
+      response_valid? response
+      response_to_array_of_hashes response['YourMembership_Response']['Members.MediaGallery.Albums.Get'], ['Album']
+    end
+
+    # Returns a member's media gallery item list, optionally filtered by album. Returns a maximum of 100 records per
+    # request.
+    #
+    # @see https://api.yourmembership.com/reference/2_00/Members_MediaGallery_Get.htm
+    #
+    # @param [YourMembership::Session] session
+    # @param [String] member_id or ProfileID of the member whose media gallery to retrieve.
+    # @param [Hash] options
+    # @option options [String] :AlbumID Filter the returned results by media gallery album.
+    # @option options [Integer] :PageSize The maximum number of records in the returned result set.
+    # @option options [Integer] :StartRecord The record number at which to start the returned result set.
+    # @return [Array] Returns an Array of Hashes representing a member's media items.
+    # @note If you attempt to retrieve a member's gallery item list and they have no media an exception will be thrown
+    #  of type 406 from YourMembership.com 'Method could not uniquely identify a record on which to operate'
+    def self.mediaGallery_get(session, member_id, options = {}) # rubocop:disable Style/MethodName
+      options = {}
+      options[:ID] = member_id
+      response = post('/', :body => build_XML_request('Members.MediaGallery.Get', session, options))
+
+      response_valid? response
+      response_to_array_of_hashes response['YourMembership_Response']['Members.MediaGallery.Get'], ['Item']
+    end
+
+    # Returns a single media gallery item.
+    #
+    # @see https://api.yourmembership.com/reference/2_00/Members_MediaGallery_Item_Get.htm
+    #
+    # @param [YourMembership::Session] session
+    # @param [String] member_id or ProfileID of the member whose media gallery item to return.
+    # @param [Integer] item_id of the media gallery item to return.
+    # @return [Hash] Returns an Hash that represents a single media item.
+    def self.mediaGallery_item_get(session, member_id, item_id) # rubocop:disable Style/MethodName
+      options = {}
+      options[:ID] = member_id
+      options[:ItemID] = item_id
+      response = post('/', :body => build_XML_request('Members.MediaGallery.Item.Get', session, options))
+
+      response_valid? response
+      response['YourMembership_Response']['Members.MediaGallery.Item.Get']
+    end
+
+    # Returns a member's wall.
+    #
+    # @see https://api.yourmembership.com/reference/2_00/Members_Wall_Get.htm
+    #
+    # @param [YourMembership::Session] session
+    # @param [String] member_id ID or ProfileID of the member's wall to get.
+    # @param [Hash] options
+    # @option options [Integer] :PageSize The maximum number of records in the returned result set.
+    # @option options [Integer] :StartRecord The record number at which to start the returned result set.
+    # @return [Hash] Returns a Hash representing the requested user's wall.
+    def self.wall_get(session, member_id, options = {})
+      options = {}
+      options[:ID] = member_id
+      response = post('/', :body => build_XML_request('Members.Wall.Get', session, options))
+
+      response_valid? response
+      response['YourMembership_Response']['Members.Wall.Get']
+    end
+  end
+end

data/lib/your_membership/people.rb

@@ -1,38 +1,38 @@
-module YourMembership
-  # YourMembership People Namespace
-  class People < YourMembership::Base
-    # Returns paged results for a search request. Returns a maximum of 100 records per request.
-    #
-    # @see https://api.yourmembership.com/reference/2_00/People_All_Search.htm
-    #
-    # @param [YourMembership::Session] session
-    # @param [Hash] options
-    # @option options [String] :SearchText Text to be searched
-    # @option options [Integer] :PageSize The maximum number of records in the returned result set.
-    # @option options [Integer] :StartRecord The record number at which to start the returned result set.
-    # @return [Array] Returns an Array of Hashes representing search results
-    def self.all_search(session, options = {})
-      response = post('/', :body => build_XML_request('People.All.Search', session, options))
-
-      response_valid? response
-      response_to_array_of_hashes response['YourMembership_Response']['People.All.Search'], ['Results', 'Item']
-    end
-
-    # Returns a person's profile data.
-    #
-    # @see https://api.yourmembership.com/reference/2_00/People_Profile_Get.htm
-    #
-    # @param [YourMembership::Session] session
-    # @param [String] id ID or ProfileID of the person's whose profile data to return.
-    # @return [YourMembership::Profile] Returns a Profile object that represents the person's profile
-    def self.profile_get(session, id)
-      options = {}
-      options['ID'] = id
-
-      response = post('/', :body => build_XML_request('People.Profile.Get', session, options))
-
-      response_valid? response
-      YourMembership::Profile.new response['YourMembership_Response']['People.Profile.Get']
-    end
-  end
-end
+module YourMembership
+  # YourMembership People Namespace
+  class People < YourMembership::Base
+    # Returns paged results for a search request. Returns a maximum of 100 records per request.
+    #
+    # @see https://api.yourmembership.com/reference/2_00/People_All_Search.htm
+    #
+    # @param [YourMembership::Session] session
+    # @param [Hash] options
+    # @option options [String] :SearchText Text to be searched
+    # @option options [Integer] :PageSize The maximum number of records in the returned result set.
+    # @option options [Integer] :StartRecord The record number at which to start the returned result set.
+    # @return [Array] Returns an Array of Hashes representing search results
+    def self.all_search(session, options = {})
+      response = post('/', :body => build_XML_request('People.All.Search', session, options))
+
+      response_valid? response
+      response_to_array_of_hashes response['YourMembership_Response']['People.All.Search'], ['Results', 'Item']
+    end
+
+    # Returns a person's profile data.
+    #
+    # @see https://api.yourmembership.com/reference/2_00/People_Profile_Get.htm
+    #
+    # @param [YourMembership::Session] session
+    # @param [String] id ID or ProfileID of the person's whose profile data to return.
+    # @return [YourMembership::Profile] Returns a Profile object that represents the person's profile
+    def self.profile_get(session, id)
+      options = {}
+      options['ID'] = id
+
+      response = post('/', :body => build_XML_request('People.Profile.Get', session, options))
+
+      response_valid? response
+      YourMembership::Profile.new response['YourMembership_Response']['People.Profile.Get']
+    end
+  end
+end

data/lib/your_membership/profile.rb

@@ -1,85 +1,92 @@
-module YourMembership
-  # The Profile object provides a convenient abstraction that encapsulates a person's profile allowing clear and concise
-  # access to both the core fields provided by YourMembership and the custom fields added by site administrators
-  #
-  # A new profile for a new person should be instantiated through the create_new method
-  #
-  # A profile can be loaded by passing a hash directly to the initializer (Profile.new) method this can be useful in
-  # creating a profile object from an API response
-  #
-  # A profile can be created empty or by passing a hash for standard and/or custom fields. This is useful for
-  # updating an existing profile without changing unnecessary records.
-  #
-  # @attr_reader [Hash] data These are fields that are part of the core YourMembership profile implementation
-  # @attr_reader [Hash] custom_data These are fields that are the ones added as Custom Fields to a YourMembership
-  #  Community
-  class Profile
-    attr_accessor :data, :custom_data
-
-    # @param [Hash] options Initial Values for the profile.
-    def initialize(options = {})
-      @data = {}
-      @custom_data = {}
-
-      options.each do |k, v|
-        if k == 'CustomFieldResponses'
-          @custom_data = parse_custom_field_responses(v)
-        else
-          @data[k] = v
-        end
-      end
-    end
-
-    # Returns the full contents of the profile in a Hash without items that have a Nil value
-    # @return [Hash]
-    def to_h
-      temp_data = clean @data
-      temp_custom_data = clean @custom_data
-      temp_data['CustomFieldResponses'] = temp_custom_data
-      temp_data
-    end
-
-    # @param [String] last_name
-    # @param [String] member_type_code
-    # @param [String] email
-    # @param [String] username
-    # @param [String] password
-    # @param [Hash] options
-    # @return [YourMembership::Profile] Builds a new profile with required and optional fields
-    # @note: It has been found that for some users you must also specify a 'Membership' field as well as the
-    #  'MemberTypeCode' The official documentation does not say this field is required but many times the user
-    #  cannot log in if no membership is provided. This means that the system cannot masquerade as this user until a
-    #  membership is specified.
-    def self.create_new(first_name, last_name, member_type_code, email, username, password, options = {})
-      options['FirstName'] = first_name
-      options['LastName'] = last_name
-      options['MemberTypeCode'] = member_type_code
-      options['EmailAddr'] = email
-      options['Username'] = username
-      options['Password'] = password
-      new(options)
-    end
-
-    private
-
-    # @param [Hash] custom_fields The 'CustomFieldResponses' Hash
-    # @return [Hash] Single dimension hash containing keys and values as strings or arrays
-    def parse_custom_field_responses(custom_fields)
-      output_hash = {}
-      custom_fields['CustomFieldResponse'].each do |field|
-        output_hash[field['FieldCode']] = field['Values']['Value'] if field['Values']
-      end
-      output_hash
-    end
-
-    # Removes nil values
-    def clean(data_hash)
-      clean_hash = {}
-      # Remove Nils
-      data_hash.each do |k, v|
-        clean_hash[k] = v if v
-      end
-      clean_hash
-    end
-  end
-end
+module YourMembership
+  # The Profile object provides a convenient abstraction that encapsulates a person's profile allowing clear and concise
+  # access to both the core fields provided by YourMembership and the custom fields added by site administrators
+  #
+  # A new profile for a new person should be instantiated through the create_new method
+  #
+  # A profile can be loaded by passing a hash directly to the initializer (Profile.new) method this can be useful in
+  # creating a profile object from an API response
+  #
+  # A profile can be created empty or by passing a hash for standard and/or custom fields. This is useful for
+  # updating an existing profile without changing unnecessary records.
+  #
+  # @attr_reader [Hash] data These are fields that are part of the core YourMembership profile implementation
+  # @attr_reader [Hash] custom_data These are fields that are the ones added as Custom Fields to a YourMembership
+  #  Community
+  class Profile
+    attr_accessor :data, :custom_data
+
+    # @param [Hash] options Initial Values for the profile.
+    def initialize(options = {})
+      @data = {}
+      @custom_data = {}
+
+      options.each do |k, v|
+        if k == 'CustomFieldResponses'
+          @custom_data = parse_custom_field_responses(v)
+        else
+          @data[k] = v
+        end
+      end
+    end
+
+    # Returns the full contents of the profile in a Hash without items that have a Nil value
+    # @return [Hash]
+    def to_h
+      temp_data = clean @data
+      temp_custom_data = clean @custom_data
+      temp_data['CustomFieldResponses'] = temp_custom_data
+      temp_data
+    end
+
+    # @param [String] last_name
+    # @param [String] member_type_code
+    # @param [String] email
+    # @param [String] username
+    # @param [String] password
+    # @param [Hash] options
+    # @return [YourMembership::Profile] Builds a new profile with required and optional fields
+    # @note: It has been found that for some users you must also specify a 'Membership' field as well as the
+    #  'MemberTypeCode' The official documentation does not say this field is required but many times the user
+    #  cannot log in if no membership is provided. This means that the system cannot masquerade as this user until a
+    #  membership is specified.
+    def self.create_new(first_name, last_name, member_type_code, email, username, password, options = {})
+      options['FirstName'] = first_name
+      options['LastName'] = last_name
+      options['MemberTypeCode'] = member_type_code
+      options['EmailAddr'] = email
+      options['Username'] = username
+      options['Password'] = password
+      new(options)
+    end
+
+    private
+
+    # @param [Hash] custom_fields The 'CustomFieldResponses' Hash
+    # @return [Hash] Single dimension hash containing keys and values as strings or arrays
+    def parse_custom_field_responses(custom_fields)
+      return {} unless custom_fields
+
+      # CustomFieldResponse may be an array (if multiple responses) or a hash
+      # (if single response). Make sure we're always dealing with an array.
+      responses = custom_fields['CustomFieldResponse']
+      responses = [responses] unless responses.is_a?(Array)
+
+      output_hash = {}
+      responses.each do |field|
+        output_hash[field['FieldCode']] = field['Values']['Value'] if field['Values']
+      end
+      output_hash
+    end
+
+    # Removes nil values
+    def clean(data_hash)
+      clean_hash = {}
+      # Remove Nils
+      data_hash.each do |k, v|
+        clean_hash[k] = v if v
+      end
+      clean_hash
+    end
+  end
+end