your_membership 1.1.5 → 1.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7cf7ce568f97cc07ebbd93245692f48882bbb6262475d67efc526f94056c28ca
-  data.tar.gz: be41c68cf27208e5e88a86966160b8aee5a53f14514d69e602eb280f9f87c6e3
+  metadata.gz: 0414125b59ee2d25c40031650648bc7c0b7cafe877f40df5509a49ea0b05f7d9
+  data.tar.gz: f72d79722d4dae7e6b1d93e2301a076ebba515ad7c2e50cc454fff04d22305a0
 SHA512:
-  metadata.gz: bc4d496cc508adbe61890f56de6d3ff80c21286befa6f1cd8c9370ed9d5267211e09ffa0f0ac1a1e0e07271bfedeafb5b674093e305e0f289230beafebff911a
-  data.tar.gz: ed4087bf859628bc964745afdd8582113c0c8576a56a272398fbfc5da34ec9030a75a0d4b32032ec8f67b66bebd1cfea36994a8afbcab27aa3ffb6667e97812f
+  metadata.gz: b7b76af5088d8cf1d24f09f041252efff15453112c1ef60559a53a570c67591c2bd4501fbc238570ca1ae9b2e7ee1aeff53c1fe207ea5fbde3ad0c285221b52a
+  data.tar.gz: 58ca1793293a33e92625f237c9480b72ce901d09863fa0dc43f82433a1a240dce653e9520f13138ea8682a23c4c9690ceb3d9d681b653bb7a935689824230915

data/CHANGELOG.md

@@ -4,6 +4,10 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [1.1.6] - 2021-02-17
+### Added
+- Allow httparty v0.18.x
+
 ## [1.1.5] - 2018-03-21
 ### Added
 - Allow httparty v0.16.x

data/lib/httparty/ym_xml_parser.rb

@@ -0,0 +1,29 @@
+require 'httparty/parser'
+
+module HTTParty
+  # Bug Fix for HTML encoded < and > in XML body. In order to parse the HTML
+  # encoded documents returned by the YourMembership API we need to HTML decode
+  # the <![CDATA[ tags.
+  #
+  # @api private
+  class YMXMLParser < HTTParty::Parser
+    # @api private
+    # @override
+    def body
+      decode(@body)
+    end
+
+    private
+
+    # @api private
+    def decode(body)
+      # <![CDATA[ = &lt;![CDATA[
+      # ]]> =  ]]&gt;
+      if !body.nil? && body.include?('&lt;![CDATA[')
+        body.gsub! '&lt;![CDATA[', '<![CDATA['
+        body.gsub! ']]&gt;', ']]>'
+      end
+      body
+    end
+  end
+end

data/lib/your_membership.rb

@@ -2,8 +2,6 @@ require "httparty"
 require "nokogiri"
 require "yaml"
 
-require "httparty/patch"
-
 require "your_membership/error"
 require "your_membership/config"
 require "your_membership/base"

data/lib/your_membership/base.rb

@@ -1,3 +1,5 @@
+require 'httparty/ym_xml_parser'
+
 module YourMembership
   # Base Class inherited by all Your Membership SDK Classes.
   class Base
@@ -22,6 +24,15 @@ module YourMembership
     end
     # rubocop:enable Style/ClassVars
 
+    # Fix bad XML from YM API by using custom parser.
+    # @api private
+    # @override HTTParty::ClassMethods#post
+    # @return [HTTParty::Response]
+    def self.post(path, options = {}, &block)
+      opt = options.merge(parser: ::HTTParty::YMXMLParser)
+      super(path, opt, &block)
+    end
+
     # 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.

data/lib/your_membership/version.rb

@@ -1,3 +1,3 @@
 module YourMembership
-  VERSION = "1.1.5"
+  VERSION = "1.1.6"
 end

data/spec/lib/httparty/ym_xml_parser_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+module HTTParty
+  RSpec.describe YMXMLParser do
+    it 'decodes HTML entities, eg. less-than, greater-than signs' do
+      body = <<~XML
+        <?xml version="1.0" encoding="utf-8" ?>
+        <YourMembership_Response>
+          <ErrCode>0</ErrCode>
+          <ExtendedErrorInfo>&lt;![CDATA[Text information here]]&gt;</ExtendedErrorInfo>
+          <Sa.Members.All.GetIDs>
+          <ServerGmtBias>-5</ServerGmtBias>
+          <ServerTime>2015-12-16 15:54:12</ServerTime>
+          <Members>
+            <ID>57EEB598-CB44-4D85-B0D6-377F393AF5B4</ID>
+            <ID>1C0CE647-FAA5-4EB0-ADF0-5B669B36378E</ID>
+          </Members>
+          </Sa.Members.All.GetIDs>
+        </YourMembership_Response>
+      XML
+      parser = described_class.new(body, :xml)
+      parsed = parser.parse
+      expect(parsed).to be_a(Hash)
+      ymr = parsed['YourMembership_Response']
+      expect(ymr['ErrCode']).to eq('0')
+      expect(ymr['ExtendedErrorInfo']).to eq('Text information here')
+    end
+  end
+end

data/spec/lib/your_membership/base_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+module YourMembership
+  RSpec.describe Base do
+    describe '.post' do
+      it 'uses YMXMLParser' do
+        mock_parser = instance_double(
+          ::HTTParty::YMXMLParser,
+          parse: { 'YourMembership_Response' => { 'ErrCode' => 999 } }
+        )
+        allow(::HTTParty::YMXMLParser).to receive(:new).and_return(mock_parser)
+        # It doesn't matter which cassette we use for this test.
+        VCR.use_cassette 'sa_members_all_getids_timestamp_single' do
+          response = described_class.post('/')
+          expect(response).to be_an(::HTTParty::Response)
+          expect(response['YourMembership_Response']).to eq('ErrCode' => 999)
+        end
+      end
+    end
+  end
+end

data/spec/lib/your_membership/profile_spec.rb

@@ -77,6 +77,7 @@ describe YourMembership::Profile do
       }
     }
   end
+
   it "accepts and sets required parameters for new profiles" do
     profile = YourMembership::Profile.create_new('afirstname', 'alastname', 'amembertypecode', 'aemail', 'ausername', 'apassword', {})
     profile.data['FirstName'].should == 'afirstname'

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
 require 'dotenv'
-require 'pry'
+require 'byebug'
 require 'vcr'
 require 'your_membership'
 require 'webmock/rspec'

data/your_membership.gemspec

@@ -21,12 +21,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "httparty", ">=0.13.1", "<0.17"
+  spec.add_dependency "httparty", ">=0.13.1", "<0.19"
   spec.add_dependency "nokogiri", "~>1.6"
 
-  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "bundler", "<3"
+  spec.add_development_dependency "byebug"
   spec.add_development_dependency "dotenv"
-  spec.add_development_dependency "pry"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "vcr"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: your_membership
 version: !ruby/object:Gem::Version
-  version: 1.1.5
+  version: 1.1.6
 platform: ruby
 authors:
 - Nate Flood
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-21 00:00:00.000000000 Z
+date: 2021-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -19,7 +19,7 @@ dependencies:
         version: 0.13.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0.19'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: 0.13.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0.19'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -48,18 +48,18 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '3'
 - !ruby/object:Gem::Dependency
-  name: dotenv
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -73,7 +73,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -161,7 +161,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- lib/httparty/patch.rb
+- lib/httparty/ym_xml_parser.rb
 - lib/your_membership.rb
 - lib/your_membership/base.rb
 - lib/your_membership/commerce.rb
@@ -187,13 +187,11 @@ files:
 - lib/your_membership/sa_people.rb
 - lib/your_membership/session.rb
 - lib/your_membership/version.rb
-- spec/fixtures/vcr_cassettes/no_body_response.yml
 - spec/fixtures/vcr_cassettes/sa_members_all_getids_timestamp_multiple.yml
 - spec/fixtures/vcr_cassettes/sa_members_all_getids_timestamp_none.yml
 - spec/fixtures/vcr_cassettes/sa_members_all_getids_timestamp_single.yml
-- spec/fixtures/vcr_cassettes/sa_members_cdata.yml
-- spec/fixtures/vcr_cassettes/sa_members_no_body.yml
-- spec/lib/httparty/patch_spec.rb
+- spec/lib/httparty/ym_xml_parser_spec.rb
+- spec/lib/your_membership/base_spec.rb
 - spec/lib/your_membership/profile_spec.rb
 - spec/lib/your_membership/sa_members_spec.rb
 - spec/spec_helper.rb
@@ -217,19 +215,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Ruby SDK for interfacing with the YourMembership.com XML API
 test_files:
-- spec/fixtures/vcr_cassettes/no_body_response.yml
 - spec/fixtures/vcr_cassettes/sa_members_all_getids_timestamp_multiple.yml
 - spec/fixtures/vcr_cassettes/sa_members_all_getids_timestamp_none.yml
 - spec/fixtures/vcr_cassettes/sa_members_all_getids_timestamp_single.yml
-- spec/fixtures/vcr_cassettes/sa_members_cdata.yml
-- spec/fixtures/vcr_cassettes/sa_members_no_body.yml
-- spec/lib/httparty/patch_spec.rb
+- spec/lib/httparty/ym_xml_parser_spec.rb
+- spec/lib/your_membership/base_spec.rb
 - spec/lib/your_membership/profile_spec.rb
 - spec/lib/your_membership/sa_members_spec.rb
 - spec/spec_helper.rb

data/lib/httparty/patch.rb

@@ -1,33 +0,0 @@
-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.nil? && body.include?('&lt;![CDATA[')
-        body.gsub! '&lt;![CDATA[', '<![CDATA['
-        body.gsub! ']]&gt', ']]>'
-      end
-      body
-    end
-  end
-end

data/spec/fixtures/vcr_cassettes/no_body_response.yml

@@ -1,48 +0,0 @@
----
-http_interactions:
-- request:
-    method: post
-    uri: https://api.yourmembership.com/
-    body:
-      encoding: UTF-8
-      string: |
-        <?xml version="1.0" encoding="UTF-8"?>
-        <YourMembership>
-          <Version>2.00</Version>
-          <ApiKey><PRIVATE_KEY></ApiKey>
-          <SaPasscode><SA_PASSCODE></SaPasscode>
-          <CallID>10000</CallID>
-          <Call Method="Sa.Members.All.GetIDs">
-            <Timestamp>2015-12-02 15:54:11</Timestamp>
-          </Call>
-        </YourMembership>
-    headers:
-      Accept-Encoding:
-      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
-      Accept:
-      - "*/*"
-      User-Agent:
-      - Ruby
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      Cache-Control:
-      - private
-      Content-Length:
-      - '24051'
-      Content-Type:
-      - text/xml; Charset=utf-8
-      Set-Cookie:
-      - "<ASP_SESSION_ID>"
-      X-Powered-By:
-      - ASP.NET
-      Date:
-      - Wed, 16 Dec 2015 20:54:12 GMT
-      Connection:
-      - Keep-alive
-      string: null
-    http_version:
-  recorded_at: Wed, 16 Dec 2015 20:54:12 GMT
-recorded_with: VCR 3.0.0

data/spec/fixtures/vcr_cassettes/sa_members_cdata.yml

@@ -1,51 +0,0 @@
----
-http_interactions:
-- request:
-    method: post
-    uri: https://api.yourmembership.com/
-    body:
-      encoding: UTF-8
-      string: |
-        <?xml version="1.0" encoding="UTF-8"?>
-        <YourMembership>
-          <Version>2.00</Version>
-          <ApiKey><PRIVATE_KEY></ApiKey>
-          <SaPasscode><SA_PASSCODE></SaPasscode>
-          <CallID>10000</CallID>
-          <Call Method="Sa.Members.All.GetIDs">
-            <Timestamp>2015-12-02 15:54:11</Timestamp>
-          </Call>
-        </YourMembership>
-    headers:
-      Accept-Encoding:
-      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
-      Accept:
-      - "*/*"
-      User-Agent:
-      - Ruby
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      Cache-Control:
-      - private
-      Content-Length:
-      - '24051'
-      Content-Type:
-      - text/xml; Charset=utf-8
-      Set-Cookie:
-      - "<ASP_SESSION_ID>"
-      X-Powered-By:
-      - ASP.NET
-      Date:
-      - Wed, 16 Dec 2015 20:54:12 GMT
-      Connection:
-      - Keep-alive
-    body:
-      encoding: UTF-8
-      string: "<?xml version=\"1.0\" encoding=\"utf-8\" ?>\r\n\r\n<YourMembership_Response>\r\n<ErrCode>0</ErrCode>\r\n<ExtendedErrorInfo>&lt;![CDATA[Text information here]]&gt;</ExtendedErrorInfo>\r\n<Sa.Members.All.GetIDs>\r\n<ServerGmtBias>-5</ServerGmtBias>\r\n<ServerTime>2015-12-16
-        15:54:12</ServerTime>\r\n<Members>\r\n<ID>57EEB598-CB44-4D85-B0D6-377F393AF5B4</ID>\r\n<ID>1C0CE647-FAA5-4EB0-ADF0-5B669B36378E</ID>\r\n</Members>\r\n</Sa.Members.All.GetIDs>\r\n</YourMembership_Response>\r\n"
-    http_version:
-  recorded_at: Wed, 16 Dec 2015 20:54:12 GMT
-recorded_with: VCR 3.0.0

data/spec/fixtures/vcr_cassettes/sa_members_no_body.yml

@@ -1,43 +0,0 @@
----
-http_interactions:
-- request:
-    method: post
-    uri: https://api.yourmembership.com/
-    body:
-      encoding: UTF-8
-      string: ''
-    headers:
-      Accept-Encoding:
-      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
-      Accept:
-      - "*/*"
-      User-Agent:
-      - Ruby
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      Cache-Control:
-      - private
-      Content-Type:
-      - text/xml; Charset=utf-8
-      Vary:
-      - Accept-Encoding
-      Server:
-      - Microsoft-IIS/8.5
-      Set-Cookie:
-      - "<ASP_SESSION_ID>"
-      X-Powered-By:
-      - ASP.NET
-      Date:
-      - Thu, 17 Aug 2017 20:18:09 GMT
-      Content-Length:
-      - '301'
-    body:
-      encoding: ASCII-8BIT
-      string: "<?xml version=\"1.0\" encoding=\"utf-8\" ?>\r\n\r\n<YourMembership_Response>\r\n<ErrCode>902</ErrCode>\r\n<ExtendedErrorInfo></ExtendedErrorInfo>\r\n<ErrDesc>XML
-        packet is malformed or otherwise unreadable.</ErrDesc>\r\n<XmlRequest>\r\n<unnamed></unnamed>\r\n</XmlRequest>\r\n</YourMembership_Response>\r\n"
-    http_version: 
-  recorded_at: Thu, 17 Aug 2017 20:18:09 GMT
-recorded_with: VCR 3.0.3

data/spec/lib/httparty/patch_spec.rb

@@ -1,35 +0,0 @@
-require 'spec_helper'
-
-describe 'FixCdata' do
-  it 'string returned' do
-    VCR.use_cassette 'sa_members_all_getids_timestamp_single' do
-      response = HTTParty.post("https://api.yourmembership.com/")
-      expect(response.body).to be_a(String)
-    end
-  end
-
-  it 'replace <![CDATA' do
-    VCR.use_cassette 'sa_members_cdata' do
-      response = HTTParty.post("https://api.yourmembership.com/")
-      expect(response.body).to include("<![CDATA[")
-    end
-  end
-
-  it 'replace ]]&gt' do
-    VCR.use_cassette 'sa_members_cdata' do
-      response = HTTParty.post("https://api.yourmembership.com/")
-      expect(response.body).to include("]]>")
-    end
-  end
-
-  it 'handle nil body response' do
-    VCR.use_cassette 'no_body_response' do
-      # The `null` in the cassette is being turned into a body of "" instead of a nil body. Stub it to be nil.
-      expect_any_instance_of(HTTParty::Response).to receive_messages(body: nil)
-      # Note that a nil body is unlikely (never) to occur within YM, but other non-YM APIs may respond with a nil body,
-      # so we need to ensure that our patch can handle that.
-      response = HTTParty.post("https://api.yourmembership.com/")
-      expect(response.body).to be nil
-    end
-  end
-end