contrast-agent 6.7.0 → 6.9.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (280) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +0 -2
  3. data/.simplecov +0 -1
  4. data/Rakefile +0 -1
  5. data/ext/cs__assess_array/cs__assess_array.c +41 -10
  6. data/ext/cs__assess_array/cs__assess_array.h +4 -1
  7. data/lib/contrast/agent/assess/policy/trigger_method.rb +3 -3
  8. data/lib/contrast/agent/assess/policy/trigger_validation/redos_validator.rb +1 -1
  9. data/lib/contrast/agent/assess/policy/trigger_validation/ssrf_validator.rb +1 -1
  10. data/lib/contrast/agent/assess/policy/trigger_validation/xss_validator.rb +1 -1
  11. data/lib/contrast/agent/assess/property/evented.rb +11 -11
  12. data/lib/contrast/agent/assess.rb +0 -1
  13. data/lib/contrast/agent/excluder.rb +53 -35
  14. data/lib/contrast/agent/exclusion_matcher.rb +21 -9
  15. data/lib/contrast/agent/middleware.rb +12 -6
  16. data/lib/contrast/agent/patching/policy/after_load_patcher.rb +6 -0
  17. data/lib/contrast/agent/protect/input_analyzer/input_analyzer.rb +146 -127
  18. data/lib/contrast/agent/protect/input_analyzer/worth_watching_analyzer.rb +116 -0
  19. data/lib/contrast/agent/protect/policy/applies_path_traversal_rule.rb +20 -0
  20. data/lib/contrast/agent/protect/policy/rule_applicator.rb +1 -1
  21. data/lib/contrast/agent/protect/rule/base.rb +47 -55
  22. data/lib/contrast/agent/protect/rule/base_service.rb +48 -24
  23. data/lib/contrast/agent/protect/rule/bot_blocker/bot_blocker_input_classification.rb +98 -0
  24. data/lib/contrast/agent/protect/rule/bot_blocker.rb +81 -0
  25. data/lib/contrast/agent/protect/rule/cmd_injection.rb +20 -2
  26. data/lib/contrast/agent/protect/rule/cmdi/cmdi_backdoors.rb +8 -5
  27. data/lib/contrast/agent/protect/rule/cmdi/cmdi_base_rule.rb +22 -22
  28. data/lib/contrast/agent/protect/rule/cmdi/cmdi_chained_command.rb +64 -0
  29. data/lib/contrast/agent/protect/rule/cmdi/cmdi_dangerous_path.rb +63 -0
  30. data/lib/contrast/agent/protect/rule/cmdi/cmdi_input_classification.rb +2 -58
  31. data/lib/contrast/agent/protect/rule/default_scanner.rb +1 -1
  32. data/lib/contrast/agent/protect/rule/deserialization.rb +3 -14
  33. data/lib/contrast/agent/protect/rule/http_method_tampering/http_method_tampering_input_classification.rb +2 -2
  34. data/lib/contrast/agent/protect/rule/http_method_tampering.rb +0 -11
  35. data/lib/contrast/agent/protect/rule/no_sqli/no_sqli_input_classification.rb +29 -34
  36. data/lib/contrast/agent/protect/rule/no_sqli.rb +25 -18
  37. data/lib/contrast/agent/protect/rule/path_traversal/path_traversal_input_classification.rb +61 -0
  38. data/lib/contrast/agent/protect/rule/path_traversal/path_traversal_semantic_security_bypass.rb +114 -0
  39. data/lib/contrast/agent/protect/rule/path_traversal.rb +40 -13
  40. data/lib/contrast/agent/protect/rule/sql_sample_builder.rb +33 -15
  41. data/lib/contrast/agent/protect/rule/sqli/sqli_base_rule.rb +0 -14
  42. data/lib/contrast/agent/protect/rule/sqli/sqli_input_classification.rb +2 -62
  43. data/lib/contrast/agent/protect/rule/sqli.rb +74 -3
  44. data/lib/contrast/agent/protect/rule/unsafe_file_upload/unsafe_file_upload_input_classification.rb +39 -63
  45. data/lib/contrast/agent/protect/rule/unsafe_file_upload.rb +6 -33
  46. data/lib/contrast/agent/protect/rule/xss/reflected_xss_input_classification.rb +58 -0
  47. data/lib/contrast/agent/protect/rule/xss.rb +15 -20
  48. data/lib/contrast/agent/protect/rule/xxe.rb +4 -24
  49. data/lib/contrast/agent/reporting/attack_result/rasp_rule_sample.rb +19 -40
  50. data/lib/contrast/agent/reporting/attack_result/response_type.rb +9 -9
  51. data/lib/contrast/agent/reporting/details/ip_denylist_details.rb +10 -2
  52. data/lib/contrast/agent/reporting/details/virtual_patch_details.rb +8 -2
  53. data/lib/contrast/agent/reporting/input_analysis/details/bot_blocker_details.rb +27 -0
  54. data/lib/contrast/agent/reporting/input_analysis/details/protect_rule_details.rb +15 -0
  55. data/lib/contrast/agent/reporting/input_analysis/input_analysis.rb +1 -2
  56. data/lib/contrast/agent/reporting/input_analysis/input_analysis_result.rb +16 -2
  57. data/lib/contrast/agent/reporting/masker/masker.rb +2 -0
  58. data/lib/contrast/agent/reporting/report.rb +1 -0
  59. data/lib/contrast/agent/reporting/reporter.rb +35 -14
  60. data/lib/contrast/agent/reporting/reporter_heartbeat.rb +3 -9
  61. data/lib/contrast/agent/reporting/reporting_events/application_activity.rb +16 -13
  62. data/lib/contrast/agent/reporting/reporting_events/application_defend_activity.rb +12 -7
  63. data/lib/contrast/agent/reporting/reporting_events/application_defend_attack_activity.rb +3 -3
  64. data/lib/contrast/agent/reporting/reporting_events/application_defend_attack_sample.rb +1 -2
  65. data/lib/contrast/agent/reporting/reporting_events/application_inventory_activity.rb +6 -1
  66. data/lib/contrast/agent/reporting/reporting_events/application_update.rb +0 -2
  67. data/lib/contrast/agent/reporting/reporting_events/architecture_component.rb +0 -1
  68. data/lib/contrast/agent/reporting/reporting_events/finding.rb +6 -6
  69. data/lib/contrast/agent/reporting/reporting_events/finding_event.rb +239 -93
  70. data/lib/contrast/agent/reporting/reporting_events/finding_event_signature.rb +10 -23
  71. data/lib/contrast/agent/reporting/reporting_events/finding_event_source.rb +10 -9
  72. data/lib/contrast/agent/reporting/reporting_events/finding_request.rb +0 -5
  73. data/lib/contrast/agent/reporting/reporting_events/library_discovery.rb +0 -1
  74. data/lib/contrast/agent/reporting/reporting_events/observed_route.rb +12 -0
  75. data/lib/contrast/agent/reporting/reporting_events/poll.rb +1 -11
  76. data/lib/contrast/agent/reporting/reporting_events/route_discovery.rb +0 -1
  77. data/lib/contrast/agent/reporting/reporting_events/route_discovery_observation.rb +0 -1
  78. data/lib/contrast/agent/reporting/reporting_events/server_reporting_event.rb +8 -0
  79. data/lib/contrast/agent/reporting/reporting_events/server_settings.rb +40 -0
  80. data/lib/contrast/agent/reporting/reporting_utilities/audit.rb +2 -2
  81. data/lib/contrast/agent/reporting/reporting_utilities/endpoints.rb +6 -0
  82. data/lib/contrast/agent/reporting/reporting_utilities/reporter_client.rb +43 -1
  83. data/lib/contrast/agent/reporting/reporting_utilities/reporter_client_utils.rb +8 -4
  84. data/lib/contrast/agent/reporting/reporting_utilities/response.rb +1 -1
  85. data/lib/contrast/agent/reporting/reporting_utilities/response_extractor.rb +58 -4
  86. data/lib/contrast/agent/reporting/reporting_utilities/response_handler.rb +4 -6
  87. data/lib/contrast/agent/reporting/reporting_utilities/response_handler_utils.rb +77 -16
  88. data/lib/contrast/agent/reporting/server_settings_worker.rb +44 -0
  89. data/lib/contrast/agent/reporting/settings/assess_server_feature.rb +14 -2
  90. data/lib/contrast/agent/reporting/settings/code_exclusion.rb +6 -1
  91. data/lib/contrast/agent/reporting/settings/exclusion_base.rb +18 -0
  92. data/lib/contrast/agent/reporting/settings/exclusions.rb +2 -1
  93. data/lib/contrast/agent/reporting/settings/helpers.rb +7 -0
  94. data/lib/contrast/agent/reporting/settings/input_exclusion.rb +9 -3
  95. data/lib/contrast/agent/reporting/settings/protect.rb +15 -15
  96. data/lib/contrast/agent/reporting/settings/protect_server_feature.rb +39 -2
  97. data/lib/contrast/agent/reporting/settings/rule_definition.rb +3 -0
  98. data/lib/contrast/agent/reporting/settings/security_logger.rb +77 -0
  99. data/lib/contrast/agent/reporting/settings/server_features.rb +9 -0
  100. data/lib/contrast/agent/reporting/settings/syslog.rb +34 -5
  101. data/lib/contrast/agent/request.rb +3 -14
  102. data/lib/contrast/agent/request_context.rb +6 -9
  103. data/lib/contrast/agent/request_context_extend.rb +9 -148
  104. data/lib/contrast/agent/request_handler.rb +5 -10
  105. data/lib/contrast/agent/telemetry/events/exceptions/telemetry_exception_event.rb +1 -1
  106. data/lib/contrast/agent/thread_watcher.rb +37 -18
  107. data/lib/contrast/agent/version.rb +1 -1
  108. data/lib/contrast/agent.rb +6 -11
  109. data/lib/contrast/agent_lib/api/command_injection.rb +46 -0
  110. data/lib/contrast/agent_lib/api/init.rb +101 -0
  111. data/lib/contrast/agent_lib/api/input_tracing.rb +267 -0
  112. data/lib/contrast/agent_lib/api/method_tempering.rb +29 -0
  113. data/lib/contrast/agent_lib/api/panic.rb +87 -0
  114. data/lib/contrast/agent_lib/api/path_semantic_file_security_bypass.rb +40 -0
  115. data/lib/contrast/agent_lib/interface.rb +260 -0
  116. data/lib/contrast/agent_lib/interface_base.rb +118 -0
  117. data/lib/contrast/agent_lib/return_types/eval_result.rb +44 -0
  118. data/lib/contrast/agent_lib/test.rb +29 -0
  119. data/lib/contrast/api/communication/connection_status.rb +20 -5
  120. data/lib/contrast/components/agent.rb +34 -14
  121. data/lib/contrast/components/api.rb +23 -0
  122. data/lib/contrast/components/app_context.rb +23 -5
  123. data/lib/contrast/components/app_context_extend.rb +0 -25
  124. data/lib/contrast/components/assess.rb +34 -4
  125. data/lib/contrast/components/assess_rules.rb +18 -0
  126. data/lib/contrast/components/base.rb +40 -0
  127. data/lib/contrast/components/config/sources.rb +95 -0
  128. data/lib/contrast/components/config.rb +19 -19
  129. data/lib/contrast/components/heap_dump.rb +10 -0
  130. data/lib/contrast/components/inventory.rb +15 -2
  131. data/lib/contrast/components/logger.rb +18 -0
  132. data/lib/contrast/components/polling.rb +36 -0
  133. data/lib/contrast/components/protect.rb +52 -2
  134. data/lib/contrast/components/ruby_component.rb +16 -1
  135. data/lib/contrast/components/sampling.rb +70 -13
  136. data/lib/contrast/components/security_logger.rb +13 -0
  137. data/lib/contrast/components/settings.rb +105 -90
  138. data/lib/contrast/config/certification_configuration.rb +14 -0
  139. data/lib/contrast/config/config.rb +46 -0
  140. data/lib/contrast/config/diagnostics.rb +114 -0
  141. data/lib/contrast/config/diagnostics_tools.rb +98 -0
  142. data/lib/contrast/config/effective_config.rb +65 -0
  143. data/lib/contrast/config/effective_config_value.rb +32 -0
  144. data/lib/contrast/config/exception_configuration.rb +12 -0
  145. data/lib/contrast/config/protect_rule_configuration.rb +8 -8
  146. data/lib/contrast/config/protect_rules_configuration.rb +23 -60
  147. data/lib/contrast/config/request_audit_configuration.rb +13 -0
  148. data/lib/contrast/config/server_configuration.rb +41 -2
  149. data/lib/contrast/configuration.rb +29 -12
  150. data/lib/contrast/extension/assess/array.rb +9 -0
  151. data/lib/contrast/extension/assess/erb.rb +1 -1
  152. data/lib/contrast/extension/delegator.rb +2 -0
  153. data/lib/contrast/framework/manager.rb +3 -1
  154. data/lib/contrast/framework/rails/railtie.rb +0 -1
  155. data/lib/contrast/framework/rails/support.rb +0 -1
  156. data/lib/contrast/tasks/config.rb +1 -8
  157. data/lib/contrast/utils/assess/event_limit_utils.rb +31 -9
  158. data/lib/contrast/utils/assess/trigger_method_utils.rb +5 -4
  159. data/lib/contrast/utils/duck_utils.rb +1 -0
  160. data/lib/contrast/utils/hash_digest.rb +2 -2
  161. data/lib/contrast/utils/input_classification_base.rb +155 -0
  162. data/lib/contrast/utils/os.rb +0 -20
  163. data/lib/contrast/utils/reporting/application_activity_batch_utils.rb +81 -0
  164. data/lib/contrast/utils/response_utils.rb +0 -16
  165. data/lib/contrast/utils/routes_sent.rb +60 -0
  166. data/lib/contrast/utils/stack_trace_utils.rb +3 -15
  167. data/lib/contrast/utils/string_utils.rb +10 -7
  168. data/lib/contrast/utils/telemetry_client.rb +1 -2
  169. data/lib/contrast/utils/timer.rb +16 -0
  170. data/lib/contrast.rb +5 -4
  171. data/resources/protect/policy.json +1 -2
  172. data/ruby-agent.gemspec +7 -6
  173. metadata +69 -130
  174. data/exe/contrast_service +0 -23
  175. data/lib/contrast/agent/assess/contrast_event.rb +0 -157
  176. data/lib/contrast/agent/assess/events/event_factory.rb +0 -34
  177. data/lib/contrast/agent/assess/events/source_event.rb +0 -46
  178. data/lib/contrast/agent/protect/rule/cmdi/cmdi_worth_watching.rb +0 -64
  179. data/lib/contrast/agent/protect/rule/sqli/sqli_worth_watching.rb +0 -118
  180. data/lib/contrast/agent/protect/rule/unsafe_file_upload/unsafe_file_upload_matcher.rb +0 -45
  181. data/lib/contrast/agent/reaction_processor.rb +0 -47
  182. data/lib/contrast/agent/reporting/reporting_events/server_activity.rb +0 -36
  183. data/lib/contrast/agent/service_heartbeat.rb +0 -35
  184. data/lib/contrast/api/communication/messaging_queue.rb +0 -128
  185. data/lib/contrast/api/communication/response_processor.rb +0 -90
  186. data/lib/contrast/api/communication/service_lifecycle.rb +0 -77
  187. data/lib/contrast/api/communication/socket.rb +0 -44
  188. data/lib/contrast/api/communication/socket_client.rb +0 -130
  189. data/lib/contrast/api/communication/speedracer.rb +0 -138
  190. data/lib/contrast/api/communication/tcp_socket.rb +0 -32
  191. data/lib/contrast/api/communication/unix_socket.rb +0 -28
  192. data/lib/contrast/api/communication.rb +0 -20
  193. data/lib/contrast/api/decorators/address.rb +0 -59
  194. data/lib/contrast/api/decorators/agent_startup.rb +0 -56
  195. data/lib/contrast/api/decorators/application_settings.rb +0 -43
  196. data/lib/contrast/api/decorators/application_startup.rb +0 -56
  197. data/lib/contrast/api/decorators/bot_blocker.rb +0 -37
  198. data/lib/contrast/api/decorators/http_request.rb +0 -137
  199. data/lib/contrast/api/decorators/input_analysis.rb +0 -18
  200. data/lib/contrast/api/decorators/instrumentation_mode.rb +0 -35
  201. data/lib/contrast/api/decorators/ip_denylist.rb +0 -37
  202. data/lib/contrast/api/decorators/message.rb +0 -67
  203. data/lib/contrast/api/decorators/rasp_rule_sample.rb +0 -52
  204. data/lib/contrast/api/decorators/response_type.rb +0 -17
  205. data/lib/contrast/api/decorators/server_features.rb +0 -25
  206. data/lib/contrast/api/decorators/user_input.rb +0 -51
  207. data/lib/contrast/api/decorators/virtual_patch.rb +0 -34
  208. data/lib/contrast/api/decorators.rb +0 -22
  209. data/lib/contrast/api/dtm.pb.rb +0 -363
  210. data/lib/contrast/api/settings.pb.rb +0 -500
  211. data/lib/contrast/api.rb +0 -16
  212. data/lib/contrast/components/contrast_service.rb +0 -88
  213. data/lib/contrast/components/service.rb +0 -55
  214. data/lib/contrast/tasks/service.rb +0 -84
  215. data/lib/contrast/utils/input_classification.rb +0 -73
  216. data/lib/protobuf/code_generator.rb +0 -129
  217. data/lib/protobuf/decoder.rb +0 -28
  218. data/lib/protobuf/deprecation.rb +0 -117
  219. data/lib/protobuf/descriptors/google/protobuf/compiler/plugin.pb.rb +0 -79
  220. data/lib/protobuf/descriptors/google/protobuf/descriptor.pb.rb +0 -360
  221. data/lib/protobuf/descriptors.rb +0 -3
  222. data/lib/protobuf/encoder.rb +0 -11
  223. data/lib/protobuf/enum.rb +0 -365
  224. data/lib/protobuf/exceptions.rb +0 -9
  225. data/lib/protobuf/field/base_field.rb +0 -380
  226. data/lib/protobuf/field/base_field_object_definitions.rb +0 -504
  227. data/lib/protobuf/field/bool_field.rb +0 -64
  228. data/lib/protobuf/field/bytes_field.rb +0 -67
  229. data/lib/protobuf/field/double_field.rb +0 -25
  230. data/lib/protobuf/field/enum_field.rb +0 -56
  231. data/lib/protobuf/field/field_array.rb +0 -102
  232. data/lib/protobuf/field/field_hash.rb +0 -122
  233. data/lib/protobuf/field/fixed32_field.rb +0 -25
  234. data/lib/protobuf/field/fixed64_field.rb +0 -28
  235. data/lib/protobuf/field/float_field.rb +0 -43
  236. data/lib/protobuf/field/int32_field.rb +0 -21
  237. data/lib/protobuf/field/int64_field.rb +0 -34
  238. data/lib/protobuf/field/integer_field.rb +0 -23
  239. data/lib/protobuf/field/message_field.rb +0 -51
  240. data/lib/protobuf/field/sfixed32_field.rb +0 -27
  241. data/lib/protobuf/field/sfixed64_field.rb +0 -28
  242. data/lib/protobuf/field/signed_integer_field.rb +0 -29
  243. data/lib/protobuf/field/sint32_field.rb +0 -21
  244. data/lib/protobuf/field/sint64_field.rb +0 -21
  245. data/lib/protobuf/field/string_field.rb +0 -51
  246. data/lib/protobuf/field/uint32_field.rb +0 -21
  247. data/lib/protobuf/field/uint64_field.rb +0 -21
  248. data/lib/protobuf/field/varint_field.rb +0 -77
  249. data/lib/protobuf/field.rb +0 -74
  250. data/lib/protobuf/generators/base.rb +0 -85
  251. data/lib/protobuf/generators/enum_generator.rb +0 -39
  252. data/lib/protobuf/generators/extension_generator.rb +0 -27
  253. data/lib/protobuf/generators/field_generator.rb +0 -193
  254. data/lib/protobuf/generators/file_generator.rb +0 -262
  255. data/lib/protobuf/generators/group_generator.rb +0 -122
  256. data/lib/protobuf/generators/message_generator.rb +0 -104
  257. data/lib/protobuf/generators/option_generator.rb +0 -17
  258. data/lib/protobuf/generators/printable.rb +0 -160
  259. data/lib/protobuf/generators/service_generator.rb +0 -50
  260. data/lib/protobuf/lifecycle.rb +0 -33
  261. data/lib/protobuf/logging.rb +0 -39
  262. data/lib/protobuf/message/fields.rb +0 -233
  263. data/lib/protobuf/message/serialization.rb +0 -85
  264. data/lib/protobuf/message.rb +0 -241
  265. data/lib/protobuf/optionable.rb +0 -72
  266. data/lib/protobuf/tasks/compile.rake +0 -80
  267. data/lib/protobuf/tasks.rb +0 -1
  268. data/lib/protobuf/varint.rb +0 -20
  269. data/lib/protobuf/varint_pure.rb +0 -31
  270. data/lib/protobuf/version.rb +0 -3
  271. data/lib/protobuf/wire_type.rb +0 -10
  272. data/lib/protobuf.rb +0 -91
  273. data/proto/dynamic_discovery.proto +0 -46
  274. data/proto/google/protobuf/compiler/plugin.proto +0 -183
  275. data/proto/google/protobuf/descriptor.proto +0 -911
  276. data/proto/rpc.proto +0 -71
  277. data/service_executables/.gitkeep +0 -0
  278. data/service_executables/VERSION +0 -1
  279. data/service_executables/linux/contrast-service +0 -0
  280. data/service_executables/mac/contrast-service +0 -0
data/lib/protobuf/enum.rb DELETED
@@ -1,365 +0,0 @@
1
- require 'delegate'
2
-
3
- ##
4
- # Adding extension to Numeric until
5
- # we can get people to stop calling #value
6
- # on Enum instances.
7
- #
8
- ::Protobuf.deprecator.define_deprecated_methods(Numeric, :value => :to_int)
9
-
10
- module Protobuf
11
- class Enum < SimpleDelegator
12
- # Public: Allows setting Options on the Enum class.
13
- ::Protobuf::Optionable.inject(self) { ::CSGoogle::Protobuf::EnumOptions }
14
-
15
- def self.aliases_allowed?
16
- get_option(:allow_alias)
17
- end
18
-
19
- # Public: Get all integer tags defined by this enum.
20
- #
21
- # Examples
22
- #
23
- # class StateMachine < ::Protobuf::Enum
24
- # set_option :allow_alias
25
- # define :ON, 1
26
- # define :STARTED, 1
27
- # define :OFF, 2
28
- # end
29
- #
30
- # StateMachine.all_tags #=> [ 1, 2 ]
31
- #
32
- # Returns an array of unique integers.
33
- #
34
- def self.all_tags
35
- @all_tags ||= enums.map(&:to_i).uniq
36
- end
37
-
38
- # Internal: DSL method to create a new Enum. The given name will
39
- # become a constant for this Enum pointing to the new instance.
40
- #
41
- # Examples
42
- #
43
- # class StateMachine < ::Protobuf::Enum
44
- # define :ON, 1
45
- # define :OFF, 2
46
- # end
47
- #
48
- # StateMachine::ON #=> #<StateMachine::ON=1>
49
- # StateMachine::OFF #=> #<StateMachine::OFF=2>
50
- #
51
- # Returns nothing.
52
- #
53
- def self.define(name, tag)
54
- enum = new(self, name, tag)
55
- @enums ||= []
56
- @enums << enum
57
- # defining a new field for the enum will cause cached @values and @mapped_enums
58
- # to be incorrect; reset them
59
- @mapped_enums = @values = nil
60
- const_set(name, enum)
61
- mapped_enums
62
- end
63
-
64
- # Internal: A mapping of enum number -> enums defined
65
- # used for speeding up our internal enum methods.
66
- def self.mapped_enums
67
- @mapped_enums ||= enums.each_with_object({}) do |enum, hash|
68
- list = hash[enum.to_i] ||= []
69
- list << enum
70
- end
71
- end
72
-
73
- # Public: All defined enums.
74
- #
75
- class << self
76
- attr_reader :enums
77
- end
78
-
79
- # Public: Get an array of Enum objects with the given tag.
80
- #
81
- # tag - An object that responds to to_i.
82
- #
83
- # Examples
84
- #
85
- # class StateMachine < ::Protobuf::Enum
86
- # set_option :allow_alias
87
- # define :ON, 1
88
- # define :STARTED, 1
89
- # define :OFF, 2
90
- # end
91
- #
92
- # StateMachine.enums_for_tag(1) #=> [ #<StateMachine::ON=1>, #<StateMachine::STARTED=1> ]
93
- # StateMachine.enums_for_tag(2) #=> [ #<StateMachine::OFF=2> ]
94
- #
95
- # Returns an array with zero or more Enum objects or nil.
96
- #
97
- def self.enums_for_tag(tag)
98
- tag && mapped_enums[tag.to_i] || []
99
- end
100
-
101
- # Public: Get the Enum associated with the given name.
102
- #
103
- # name - A string-like object. Case-sensitive.
104
- #
105
- # Example
106
- #
107
- # class StateMachine < ::Protobuf::Enum
108
- # define :ON, 1
109
- # define :OFF, 2
110
- # end
111
- #
112
- # StateMachine.enum_for_name(:ON) # => #<StateMachine::ON=1>
113
- # StateMachine.enum_for_name("ON") # => #<StateMachine::ON=1>
114
- # StateMachine.enum_for_name(:on) # => nil
115
- # StateMachine.enum_for_name(:FOO) # => nil
116
- #
117
- # Returns the Enum object with the given name or nil.
118
- #
119
- def self.enum_for_name(name)
120
- const_get(name)
121
- rescue ::NameError
122
- nil
123
- end
124
-
125
- # Public: Get the Enum object corresponding to the given tag.
126
- #
127
- # tag - An object that responds to to_i.
128
- #
129
- # Returns an Enum object or nil. If the tag corresponds to multiple
130
- # Enums, the first enum defined will be returned.
131
- #
132
- def self.enum_for_tag(tag)
133
- tag && (mapped_enums[tag.to_i] || []).first
134
- end
135
-
136
- def self.enum_for_tag_integer(tag)
137
- (@mapped_enums[tag] || []).first
138
- end
139
-
140
- # Public: Get an Enum by a variety of type-checking mechanisms.
141
- #
142
- # candidate - An Enum, Numeric, String, or Symbol object.
143
- #
144
- # Example
145
- #
146
- # class StateMachine < ::Protobuf::Enum
147
- # set_option :allow_alias
148
- # define :ON, 1
149
- # define :STARTED, 1
150
- # define :OFF, 2
151
- # end
152
- #
153
- # StateMachine.fetch(StateMachine::ON) # => #<StateMachine::ON=1>
154
- # StateMachine.fetch(:ON) # => #<StateMachine::ON=1>
155
- # StateMachine.fetch("STARTED") # => #<StateMachine::STARTED=1>
156
- # StateMachine.fetch(1) # => [ #<StateMachine::ON=1>, #<StateMachine::STARTED=1> ]
157
- #
158
- # Returns an Enum object or nil.
159
- #
160
- def self.fetch(candidate)
161
- return enum_for_tag_integer(candidate) if candidate.is_a?(::Integer)
162
-
163
- case candidate
164
- when self
165
- candidate
166
- when ::Numeric
167
- enum_for_tag(candidate.to_i)
168
- when ::String, ::Symbol
169
- enum_for_name(candidate)
170
- else
171
- nil
172
- end
173
- end
174
-
175
- # Public: Get the Symbol name associated with the given number.
176
- #
177
- # number - An object that responds to to_i.
178
- #
179
- # Examples
180
- #
181
- # # Without aliases
182
- # class StateMachine < ::Protobuf::Enum
183
- # define :ON, 1
184
- # define :OFF, 2
185
- # end
186
- #
187
- # StateMachine.name_for_tag(1) # => :ON
188
- # StateMachine.name_for_tag(2) # => :OFF
189
- # StateMachine.name_for_tag(3) # => nil
190
- #
191
- # # With aliases
192
- # class StateMachine < ::Protobuf::Enum
193
- # set_option :allow_alias
194
- # define :STARTED, 1
195
- # define :ON, 1
196
- # define :OFF, 2
197
- # end
198
- #
199
- # StateMachine.name_for_tag(1) # => :STARTED
200
- # StateMachine.name_for_tag(2) # => :OFF
201
- #
202
- # Returns the symbol name of the enum constant given it's associated tag or nil.
203
- # If the given tag has multiple names associated (due to allow_alias)
204
- # the first defined name will be returned.
205
- #
206
- def self.name_for_tag(tag)
207
- enum_for_tag(tag).try(:name)
208
- end
209
-
210
- # Public: Check if the given tag is defined by this Enum.
211
- #
212
- # number - An object that responds to to_i.
213
- #
214
- # Returns a boolean.
215
- #
216
- def self.valid_tag?(tag)
217
- tag.respond_to?(:to_i) && mapped_enums.key?(tag.to_i)
218
- end
219
-
220
- # Public: [DEPRECATED] Return a hash of Enum objects keyed
221
- # by their :name.
222
- #
223
- def self.values
224
- @values ||= enums.each_with_object({}) do |enum, hash|
225
- hash[enum.name] = enum
226
- end
227
- end
228
-
229
- ##
230
- # Class Deprecations
231
- #
232
- class << self
233
- ::Protobuf.deprecator.define_deprecated_methods(
234
- self,
235
- :enum_by_value => :enum_for_tag,
236
- :name_by_value => :name_for_tag,
237
- :get_name_by_tag => :name_for_tag,
238
- :value_by_name => :enum_for_name,
239
- )
240
-
241
- ::Protobuf.deprecator.deprecate_methods(self, :values => :enums)
242
- end
243
-
244
- ##
245
- # Attributes
246
- #
247
-
248
- private
249
-
250
- attr_writer :parent_class, :name, :tag
251
-
252
- public
253
-
254
- attr_reader :parent_class, :name, :tag
255
-
256
- ##
257
- # Instance Methods
258
- #
259
-
260
- def initialize(parent_class, name, tag)
261
- self.parent_class = parent_class
262
- self.name = name
263
- self.tag = tag
264
- super(tag)
265
- end
266
-
267
- # Custom equality method since otherwise identical values from different
268
- # enums will be considered equal by Integer's equality method (or
269
- # Fixnum's on Ruby < 2.4.0).
270
- #
271
- def ==(other)
272
- if other.is_a?(Protobuf::Enum)
273
- parent_class == other.parent_class && tag == other.tag
274
- elsif tag.class == other.class
275
- tag == other
276
- else
277
- false
278
- end
279
- end
280
-
281
- # Overriding the class so ActiveRecord/Arel visitor will visit the enum as an
282
- # Integer.
283
- #
284
- def class
285
- # This is done for backward compatibility for < 2.4.0. This ensures that
286
- # if Ruby version >= 2.4.0, this will return Integer. If below, then will
287
- # return Fixnum.
288
- #
289
- # This prevents the constant deprecation warnings on Fixnum.
290
- tag.class
291
- end
292
-
293
- # Protobuf::Enum delegates methods to Fixnum, which has a custom hash equality method (`eql?`)
294
- # This causes enum values to be equivalent when using `==`, `===`, `equals?`, but not `eql?`**:
295
- #
296
- # 2.3.7 :002 > ::Test::EnumTestType::ZERO.eql?(::Test::EnumTestType::ZERO)
297
- # => false
298
- #
299
- # However, they are equilvalent to their tag value:
300
- #
301
- # 2.3.7 :002 > ::Test::EnumTestType::ZERO.eql?(::Test::EnumTestType::ZERO.tag)
302
- # => true
303
- #
304
- # **The implementation changed in Ruby 2.5, so this only affects Ruby versions less than v2.4.
305
- #
306
- # Use the hash equality implementation from Object#eql?, which is equivalent to == instead.
307
- #
308
- def eql?(other)
309
- self == other
310
- end
311
-
312
- def inspect
313
- "\#<Protobuf::Enum(#{parent_class})::#{name}=#{tag}>"
314
- end
315
-
316
- def to_int
317
- tag.to_int
318
- end
319
-
320
- # This fixes a reflection bug in JrJackson RubyAnySerializer that does not
321
- # render Protobuf enums correctly because to_json is not defined. It takes
322
- # any number of arguments to support the JSON gem trying to pass an argument.
323
- # NB: This method is required to return a string and not an integer.
324
- #
325
- def to_json(*)
326
- to_s
327
- end
328
-
329
- def to_s(format = :tag)
330
- case format
331
- when :tag
332
- to_i.to_s
333
- when :name
334
- name.to_s
335
- else
336
- to_i.to_s
337
- end
338
- end
339
-
340
- # Re-implement `try` in order to fix the problem where
341
- # the underlying fixnum doesn't respond to all methods (e.g. name or tag).
342
- # If we respond to the first argument, `__send__` the args. Otherwise,
343
- # delegate the `try` call to the underlying vlaue fixnum.
344
- #
345
- def try(*args, &block)
346
- case
347
- when args.empty? && block_given?
348
- yield self
349
- when respond_to?(args.first)
350
- __send__(*args, &block)
351
- else
352
- @tag.try(*args, &block)
353
- end
354
- end
355
-
356
- ##
357
- # Instance Aliases
358
- #
359
- alias :to_i tag
360
- alias :to_hash_value tag
361
- alias :to_json_hash_value tag
362
-
363
- ::Protobuf.deprecator.define_deprecated_methods(self, :value => :to_i)
364
- end
365
- end
@@ -1,9 +0,0 @@
1
- module Protobuf
2
- class Error < StandardError; end
3
- class InvalidWireType < Error; end
4
- class NotInitializedError < Error; end
5
- class TagCollisionError < Error; end
6
- class SerializationError < StandardError; end
7
- class FieldNotDefinedError < StandardError; end
8
- class DuplicateFieldNameError < StandardError; end
9
- end