intercom 4.2.1 → 4.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a680039a8ef799d52b227657866f60afa19bf4b292f9d70646c8f962eca11a0
-  data.tar.gz: 40317d4521715f294bec48805ed9edf6f83406260b5c74bde5e9cf96cdf9cb8c
+  metadata.gz: 97caaa1c044ea1370944d335cfc0d6e004966d8f84ba547a83ca78daa2be3d11
+  data.tar.gz: dfd96074bef226daa006f2b4c18aa2b6b6ee5a582301ea18e783962a5a4bcab9
 SHA512:
-  metadata.gz: df28a00dc009f9e7bd94fa497021312d4cbe005905eea6095d1efe1172f567d8f806a47750843e129cfae5af80db038aea355ba2f1a2b5122142893574d9d977
-  data.tar.gz: d57709458d73737890f1933264f10b23c486a08840bd3a561c8971dbfef3d2ad88b4ddb2d393154b4127cd78196a39a56c93c0f08c747c74bd303c729d01fc5f
+  metadata.gz: dfec5a80b9442a047087608f564db3d9380ae106e4cffae99f11d9e1c33915e5a984957712ea7f09d213abd4cd968cee6d642d241d2a9ef7020a30a1ce953497
+  data.tar.gz: a7370a062eff270da20077fba81930af2cdfa92f9845583bdf498ee95bc18867672577d916bf57843bbf07ed16da5524e971e85e97827ee578efa53a753303a5

data/.circleci/config.yml

@@ -1,35 +1,91 @@
-version: 2
+version: 2.1
 jobs:
-  "Test against Ruby 2.4":
+  test-ruby-2-4:
     docker:
       - image: circleci/ruby:2.4.9
     working_directory: ~/intercom-ruby
     steps:
       - checkout
+      - run:
+          name: Route Bundler through the Socket Firewall registry
+          command: |
+            set -euo pipefail
+            if [ -z "${SOCKET_GEM_URL:-}" ]; then
+              # CircleCI does not share context credentials with forked PRs, so a
+              # fork cannot be routed. Say so rather than failing the contributor.
+              if [ -n "${CIRCLE_PR_REPONAME:-}" ]; then
+                echo "Forked PR: no Socket Firewall credentials available, gems will come from rubygems.org."
+                exit 0
+              fi
+              echo "FATAL: SOCKET_GEM_URL is required (provided by the socket-firewall context)"
+              exit 1
+            fi
+            # Legacy two-argument form: these images ship Bundler 1.x, where
+            # `bundle config set --global` does not exist and silently no-ops.
+            bundle config mirror.https://rubygems.org "$SOCKET_GEM_URL"
+            bundle config mirror.https://rubygems.org | grep -q socket-firewall-registry \
+              || { echo "FAIL: bundler mirror not pointing at Socket Firewall"; exit 1; }
       - run: bundle install
       - run: bundle exec rake
-  "Test against Ruby 2.5":
+  test-ruby-2-5:
     docker:
       - image: circleci/ruby:2.5.7
     working_directory: ~/intercom-ruby
     steps:
       - checkout
+      - run:
+          name: Route Bundler through the Socket Firewall registry
+          command: |
+            set -euo pipefail
+            if [ -z "${SOCKET_GEM_URL:-}" ]; then
+              if [ -n "${CIRCLE_PR_REPONAME:-}" ]; then
+                echo "Forked PR: no Socket Firewall credentials available, gems will come from rubygems.org."
+                exit 0
+              fi
+              echo "FATAL: SOCKET_GEM_URL is required (provided by the socket-firewall context)"
+              exit 1
+            fi
+            bundle config mirror.https://rubygems.org "$SOCKET_GEM_URL"
+            bundle config mirror.https://rubygems.org | grep -q socket-firewall-registry \
+              || { echo "FAIL: bundler mirror not pointing at Socket Firewall"; exit 1; }
       - run: bundle install
       - run: bundle exec rake
-  "Test against Ruby 2.6":
+  test-ruby-2-6:
     docker:
       - image: circleci/ruby:2.6.5
     working_directory: ~/intercom-ruby
     steps:
       - checkout
+      - run:
+          name: Route Bundler through the Socket Firewall registry
+          command: |
+            set -euo pipefail
+            if [ -z "${SOCKET_GEM_URL:-}" ]; then
+              if [ -n "${CIRCLE_PR_REPONAME:-}" ]; then
+                echo "Forked PR: no Socket Firewall credentials available, gems will come from rubygems.org."
+                exit 0
+              fi
+              echo "FATAL: SOCKET_GEM_URL is required (provided by the socket-firewall context)"
+              exit 1
+            fi
+            bundle config mirror.https://rubygems.org "$SOCKET_GEM_URL"
+            bundle config mirror.https://rubygems.org | grep -q socket-firewall-registry \
+              || { echo "FAIL: bundler mirror not pointing at Socket Firewall"; exit 1; }
       - run: bundle install
       - run: bundle exec rake
 
 workflows:
-  version: 2
   build_and_test:
     jobs:
-      - "Test against Ruby 2.4"
-      - "Test against Ruby 2.5"
-      - "Test against Ruby 2.6"
-
+      - test-ruby-2-4:
+          name: "Test against Ruby 2.4"
+          context:
+            - socket-firewall
+      - test-ruby-2-5:
+          name: "Test against Ruby 2.5"
+          context:
+            - socket-firewall
+      - test-ruby-2-6:
+          name: "Test against Ruby 2.6"
+          context:
+            - socket-firewall

data/Gemfile

@@ -1,4 +1,4 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 gem 'webmock'
 gemspec

data/README.md

@@ -170,7 +170,7 @@ contact.remove_company(id: company.id)
 contact.companies.each {|c| p c.name}
 
 # attach a subscription_types on a contact
-contact.create_subscription_types(id: subscription_type.id)
+contact.create_subscription_type(id: subscription_type.id)
 
 # List subscription_types for a contact
 contact.subscription_types.each {|n| p n.id}

data/changes.txt

@@ -1,3 +1,10 @@
+4.2.3
+- Fixed SyntaxError when reading articles with hyphenated locales
+
+4.2.2
+- Fixed FlatStore to skip hash values when building API request payloads
+- Removed hash validation on FlatStore reads to allow for custom objects
+
 4.1.3
 - Updated ReadMe with more errors.
 - Fixed issue where paginated requests could only be iterated through once.

data/intercom.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'minitest', '~> 5.4'
   spec.add_development_dependency "m", "~> 1.5.0"
   spec.add_development_dependency 'rake', '~> 10.3'
-  spec.add_development_dependency 'mocha', '~> 1.0'
+  spec.add_development_dependency 'mocha', '~> 2.0'
   spec.add_development_dependency "fakeweb", ["~> 1.3"]
   spec.add_development_dependency "pry"
 

data/lib/intercom/lib/dynamic_accessors.rb

@@ -17,39 +17,46 @@ module Intercom
         private
 
         def define_flat_store_based_accessors(attribute, value, object)
-          object.instance_eval %Q"
-            def #{attribute}=(value)
-              mark_field_as_changed!(:#{attribute})
-              @#{attribute} = Intercom::Lib::FlatStore.new(value)
+          ivar = ivar_name(attribute, object)
+          object.singleton_class.class_eval do
+            define_method("#{attribute}=") do |val|
+              mark_field_as_changed!(attribute.to_sym)
+              instance_variable_set(ivar, Intercom::Lib::FlatStore.new(val))
             end
-            def #{attribute}
-              @#{attribute}
-            end
-          "
+            define_method(attribute) { instance_variable_get(ivar) }
+          end
         end
 
         def define_date_based_accessors(attribute, value, object)
-          object.instance_eval %Q"
-            def #{attribute}=(value)
-              mark_field_as_changed!(:#{attribute})
-              @#{attribute} = value.nil? ? nil : value.to_i
+          ivar = ivar_name(attribute, object)
+          object.singleton_class.class_eval do
+            define_method("#{attribute}=") do |val|
+              mark_field_as_changed!(attribute.to_sym)
+              instance_variable_set(ivar, val.nil? ? nil : val.to_i)
             end
-            def #{attribute}
-              @#{attribute}.nil? ? nil : Time.at(@#{attribute})
+            define_method(attribute) do
+              time = instance_variable_get(ivar)
+              time.nil? ? nil : Time.at(time)
             end
-          "
+          end
         end
 
         def define_standard_accessors(attribute, value, object)
-            object.instance_eval %Q"
-              def #{attribute}=(value)
-                mark_field_as_changed!(:#{attribute})
-                @#{attribute} = value
-              end
-              def #{attribute}
-                @#{attribute}
-              end
-            "
+          ivar = ivar_name(attribute, object)
+          object.singleton_class.class_eval do
+            define_method("#{attribute}=") do |val|
+              mark_field_as_changed!(attribute.to_sym)
+              instance_variable_set(ivar, val)
+            end
+            define_method(attribute) { instance_variable_get(ivar) }
+          end
+        end
+
+        # Keys such as "pt-BR" are not valid identifiers, so normalise them for the ivar name.
+        def ivar_name(attribute, object)
+          ivar = "@#{attribute.to_s.gsub(/\W/, '_')}"
+          object.register_attribute_key(ivar, attribute) if ivar != "@#{attribute}"
+          ivar
         end
 
       end

data/lib/intercom/lib/flat_store.rb

@@ -2,7 +2,7 @@ module Intercom
   module Lib
 
     # Sub-class of {Hash} for storing custom data attributes.
-    # Doesn't allow nested Hashes or Arrays. And requires {String} or {Symbol} keys.
+    # Doesn't allow Arrays. And requires {String} or {Symbol} keys.
     class FlatStore < Hash
 
       def initialize(attributes={})
@@ -21,9 +21,16 @@ module Intercom
         super(key.to_s)
       end
 
+      def to_submittable_hash
+        # Filter out Custom Object references when submitting to API
+        self.reject do |key, value|
+          value.is_a?(Hash)
+        end
+      end
+
       private
       def validate_key_and_value(key, value)
-        raise ArgumentError.new("This does not support nested data structures (key: #{key}, value: #{value}") if value.is_a?(Array) || value.is_a?(Hash)
+        raise ArgumentError.new("This does not support nested data structures (key: #{key}, value: #{value}") if value.is_a?(Array)
         raise ArgumentError.new("Key must be String or Symbol: #{key}") unless key.is_a?(String) || key.is_a?(Symbol)
       end
     end

data/lib/intercom/traits/api_resource.rb

@@ -37,7 +37,7 @@ module Intercom
 
       def to_hash
         instance_variables_excluding_dirty_tracking_field.each_with_object({}) do |variable, hash|
-          hash[variable.to_s.delete('@')] = instance_variable_get(variable)
+          hash[attribute_key(variable)] = instance_variable_get(variable)
         end
       end
 
@@ -46,10 +46,18 @@ module Intercom
           next if variable == :@client
 
           value = instance_variable_get(variable)
-          hash[variable.to_s.delete('@')] = value.respond_to?(:to_json) ? value.to_json(*args) : value
+          hash[attribute_key(variable)] = value.respond_to?(:to_json) ? value.to_json(*args) : value
         end
       end
 
+      def register_attribute_key(ivar, attribute)
+        (@attribute_keys ||= {})[ivar.to_sym] = attribute.to_s
+      end
+
+      def attribute_key(variable)
+        (@attribute_keys || {}).fetch(variable, variable.to_s.delete('@'))
+      end
+
       def to_submittable_hash
         submittable_hash = {}
         to_hash.each do |attribute, value|

data/lib/intercom/traits/dirty_tracking.rb

@@ -22,7 +22,7 @@ module Intercom
 
       def field_changed?(field_name)
         @changed_fields ||= Set.new
-        field = instance_variable_get("@#{field_name}")
+        field = instance_variable_get("@#{field_name.to_s.gsub(/\W/, '_')}")
         if field.respond_to?(:field_changed?)
           field.to_hash.any? do |attribute, _|
             field.field_changed?(attribute)
@@ -33,7 +33,7 @@ module Intercom
       end
 
       def instance_variables_excluding_dirty_tracking_field
-        instance_variables.reject{|var| var == :@changed_fields}
+        instance_variables.reject{|var| var == :@changed_fields || var == :@attribute_keys}
       end
     end
   end

data/lib/intercom/version.rb

@@ -1,3 +1,3 @@
 module Intercom #:nodoc:
-  VERSION = "4.2.1"
+  VERSION = "4.2.3"
 end

data/spec/spec_helper.rb

@@ -2,7 +2,7 @@
 
 require 'intercom'
 require 'minitest/autorun'
-require 'mocha/setup'
+require 'mocha/minitest'
 require 'webmock'
 require 'time'
 require 'pry'

data/spec/unit/intercom/article_spec.rb

@@ -37,4 +37,22 @@ describe "Intercom::Article" do
       client.articles.delete(article)
     end
   end
-end
+
+  describe "Parsing an Article" do
+    it "handles hyphenated locale keys in translated content" do
+      article = Intercom::Article.from_api(
+        "id" => "1",
+        "type" => "article",
+        "translated_content" => {
+          "type" => "article_translated_content",
+          "fr" => { "type" => "article_content", "title" => "Bonjour" },
+          "pt-BR" => { "type" => "article_content", "title" => "Ola" }
+        }
+      )
+      _(article.translated_content.fr.title).must_equal "Bonjour"
+      _(article.translated_content.public_send("pt-BR").title).must_equal "Ola"
+      article.translated_content.public_send("pt-BR").title = "Oi"
+      _(article.to_submittable_hash).must_equal("translated_content" => { "pt-BR" => { "title" => "Oi" } })
+    end
+  end
+end

data/spec/unit/intercom/contact_spec.rb

@@ -90,12 +90,10 @@ describe Intercom::Contact do
     _(contact.to_hash['custom_attributes']).must_equal 'mad' => 123, 'other' => now.to_i, 'thing' => 'yay'
   end
 
-  it 'rejects nested data structures in custom_attributes' do
+  it 'rejects lists in custom_attributes' do
     contact = Intercom::Contact.new
 
     _(proc { contact.custom_attributes['thing'] = [1] }).must_raise(ArgumentError)
-    _(proc { contact.custom_attributes['thing'] = { 1 => 2 } }).must_raise(ArgumentError)
-    _(proc { contact.custom_attributes['thing'] = { 1 => { 2 => 3 } } }).must_raise(ArgumentError)
 
     contact = Intercom::Contact.new(test_contact)
     _(proc { contact.custom_attributes['thing'] = [1] }).must_raise(ArgumentError)

data/spec/unit/intercom/lib/flat_store_spec.rb

@@ -3,11 +3,15 @@
 require 'spec_helper'
 
 describe Intercom::Lib::FlatStore do
-  it 'raises if you try to set or merge in nested hash structures' do
+  it 'raises if you try to set arrays but allows hashes' do
     data = Intercom::Lib::FlatStore.new
     _(proc { data['thing'] = [1] }).must_raise ArgumentError
-    _(proc { data['thing'] = { 1 => 2 } }).must_raise ArgumentError
-    _(proc { Intercom::Lib::FlatStore.new(1 => { 2 => 3 }) }).must_raise ArgumentError
+  
+    data['thing'] = { 'key' => 'value' }
+    _(data['thing']).must_equal({ 'key' => 'value' })
+    
+    flat_store = Intercom::Lib::FlatStore.new('custom_object' => { 'type' => 'Order.list', 'instances' => [{'id' => '123'}] })
+    _(flat_store['custom_object']).must_equal({ 'type' => 'Order.list', 'instances' => [{'id' => '123'}] })
   end
 
   it 'raises if you try to use a non string key' do
@@ -28,4 +32,30 @@ describe Intercom::Lib::FlatStore do
     _(data['b']).must_equal 2
     _(data[:b]).must_equal 2
   end
+
+  describe '#to_submittable_hash' do
+    it 'filters out all hash values' do
+      data = Intercom::Lib::FlatStore.new(
+        'regular_attr' => 'value',
+        'number_attr' => 42,
+        'custom_object' => {
+          'type' => 'Order.list',
+          'instances' => [
+            { 'id' => '31', 'external_id' => 'ext_123' }
+          ]
+        },
+        'regular_hash' => { 'key' => 'value' },
+        'metadata' => { 'source' => 'api', 'version' => 2 }
+      )
+      
+      submittable = data.to_submittable_hash
+      
+      _(submittable['regular_attr']).must_equal 'value'
+      _(submittable['number_attr']).must_equal 42
+      
+      _(submittable.key?('custom_object')).must_equal false
+      _(submittable.key?('regular_hash')).must_equal false
+      _(submittable.key?('metadata')).must_equal false
+    end
+  end
 end

data/spec/unit/intercom/user_spec.rb

@@ -106,12 +106,10 @@ describe 'Intercom::User' do
     _(user.to_hash['companies']).must_equal companies
   end
 
-  it 'rejects nested data structures in custom_attributes' do
+  it 'rejects lists in custom_attributes' do
     user = Intercom::User.new
 
     _(proc { user.custom_attributes['thing'] = [1] }).must_raise(ArgumentError)
-    _(proc { user.custom_attributes['thing'] = { 1 => 2 } }).must_raise(ArgumentError)
-    _(proc { user.custom_attributes['thing'] = { 1 => { 2 => 3 } } }).must_raise(ArgumentError)
 
     user = Intercom::User.from_api(test_user)
     _(proc { user.custom_attributes['thing'] = [1] }).must_raise(ArgumentError)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: intercom
 version: !ruby/object:Gem::Version
-  version: 4.2.1
+  version: 4.2.3
 platform: ruby
 authors:
 - Ben McRedmond
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-16 00:00:00.000000000 Z
+date: 2026-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -65,14 +65,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: fakeweb
   requirement: !ruby/object:Gem::Requirement
@@ -279,7 +279,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.16
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for the Intercom API