Merge pull request #82 from ynab/gracefully-handle-invalid-flag

Gracefully handle invalid transaction flag values from server

Author: bradymholt

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ynab (3.4.0)
+    ynab (3.5.0)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM

config.json

@@ -41,8 +41,12 @@ def self.build_from_hash(value)
     # @param [String] The enum value in the form of the string
     # @return [String] The enum value
     def build_from_hash(value)
-      return value if AccountType.all_vars.include?(value)
-      raise "Invalid ENUM value #{value} for class #AccountType"
+      if AccountType.all_vars.include?(value)
+        return value
+      else
+        return nil
+      end
     end
   end
+
 end

lib/ynab/models/account_type.rb

@@ -41,8 +41,12 @@ def self.build_from_hash(value)
     # @param [String] The enum value in the form of the string
     # @return [String] The enum value
     def build_from_hash(value)
-      return value if ScheduledTransactionFrequency.all_vars.include?(value)
-      raise "Invalid ENUM value #{value} for class #ScheduledTransactionFrequency"
+      if ScheduledTransactionFrequency.all_vars.include?(value)
+        return value
+      else
+        return nil
+      end
     end
   end
+
 end

lib/ynab/models/scheduled_transaction_frequency.rb

@@ -31,8 +31,12 @@ def self.build_from_hash(value)
     # @param [String] The enum value in the form of the string
     # @return [String] The enum value
     def build_from_hash(value)
-      return value if TransactionClearedStatus.all_vars.include?(value)
-      raise "Invalid ENUM value #{value} for class #TransactionClearedStatus"
+      if TransactionClearedStatus.all_vars.include?(value)
+        return value
+      else
+        return nil
+      end
     end
   end
+
 end

lib/ynab/models/transaction_cleared_status.rb

@@ -35,8 +35,12 @@ def self.build_from_hash(value)
     # @param [String] The enum value in the form of the string
     # @return [String] The enum value
     def build_from_hash(value)
-      return value if TransactionFlagColor.all_vars.include?(value)
-      raise "Invalid ENUM value #{value} for class #TransactionFlagColor"
+      if TransactionFlagColor.all_vars.include?(value)
+        return value
+      else
+        return nil
+      end
     end
   end
+
 end

lib/ynab/models/transaction_flag_color.rb

@@ -44,6 +44,18 @@
         expect(response.data.transactions.length).to be 2
       end
     end
+
+    it 'gracefully handles invalid flag_color values' do
+      # transactions_invalid_flags contains transactions with invalid/unsupported flag_color values
+      VCR.use_cassette("transactions_invalid_flags") do
+        response = instance.get_transactions(budget_id)
+        expect(client.last_request.response.options[:code]).to be 200
+        expect(response.data.transactions.length).to be 2
+        # We expect the flag_color to have been converted to nil for these transactions
+        expect(response.data.transactions[0].flag_color).to be_nil
+        expect(response.data.transactions[1].flag_color).to be_nil
+      end
+    end
   end
 
   describe 'GET /budgets/{budget_id}/category/{category_id}/transactions' do

spec/api/transactions_spec.rb

@@ -0,0 +1,26 @@
+  class {{classname}}{{#allowableValues}}{{#enumVars}}
+    {{{name}}} = {{{value}}}.freeze{{/enumVars}}
+
+{{/allowableValues}}
+    def self.all_vars
+      @all_vars ||= [{{#allowableValues}}{{#enumVars}}{{{name}}}{{^-last}}, {{/-last}}{{/enumVars}}{{/allowableValues}}].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      if {{classname}}.all_vars.include?(value)
+        return value
+      else
+        return nil
+      end
+    end
+  end