berrycrawl 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (136) hide show
  1. checksums.yaml +7 -0
  2. data/.fern/metadata.json +12 -0
  3. data/.rubocop.yml +103 -0
  4. data/CONTRIBUTING.md +120 -0
  5. data/LICENSE +17 -0
  6. data/README.md +183 -0
  7. data/Rakefile +20 -0
  8. data/custom.gemspec.rb +16 -0
  9. data/lib/Berrycrawl/account/client.rb +44 -0
  10. data/lib/Berrycrawl/brand/client.rb +48 -0
  11. data/lib/Berrycrawl/brand/types/brand_dto.rb +15 -0
  12. data/lib/Berrycrawl/client.rb +268 -0
  13. data/lib/Berrycrawl/environment.rb +7 -0
  14. data/lib/Berrycrawl/errors/api_error.rb +8 -0
  15. data/lib/Berrycrawl/errors/client_error.rb +17 -0
  16. data/lib/Berrycrawl/errors/redirect_error.rb +8 -0
  17. data/lib/Berrycrawl/errors/response_error.rb +42 -0
  18. data/lib/Berrycrawl/errors/server_error.rb +11 -0
  19. data/lib/Berrycrawl/errors/timeout_error.rb +8 -0
  20. data/lib/Berrycrawl/internal/errors/constraint_error.rb +10 -0
  21. data/lib/Berrycrawl/internal/errors/type_error.rb +10 -0
  22. data/lib/Berrycrawl/internal/http/base_request.rb +51 -0
  23. data/lib/Berrycrawl/internal/http/raw_client.rb +252 -0
  24. data/lib/Berrycrawl/internal/iterators/cursor_item_iterator.rb +28 -0
  25. data/lib/Berrycrawl/internal/iterators/cursor_page_iterator.rb +63 -0
  26. data/lib/Berrycrawl/internal/iterators/item_iterator.rb +65 -0
  27. data/lib/Berrycrawl/internal/iterators/offset_item_iterator.rb +30 -0
  28. data/lib/Berrycrawl/internal/iterators/offset_page_iterator.rb +103 -0
  29. data/lib/Berrycrawl/internal/json/request.rb +41 -0
  30. data/lib/Berrycrawl/internal/json/serializable.rb +25 -0
  31. data/lib/Berrycrawl/internal/multipart/multipart_encoder.rb +141 -0
  32. data/lib/Berrycrawl/internal/multipart/multipart_form_data.rb +78 -0
  33. data/lib/Berrycrawl/internal/multipart/multipart_form_data_part.rb +51 -0
  34. data/lib/Berrycrawl/internal/multipart/multipart_request.rb +40 -0
  35. data/lib/Berrycrawl/internal/types/array.rb +47 -0
  36. data/lib/Berrycrawl/internal/types/boolean.rb +34 -0
  37. data/lib/Berrycrawl/internal/types/enum.rb +56 -0
  38. data/lib/Berrycrawl/internal/types/hash.rb +36 -0
  39. data/lib/Berrycrawl/internal/types/model/field.rb +38 -0
  40. data/lib/Berrycrawl/internal/types/model.rb +208 -0
  41. data/lib/Berrycrawl/internal/types/type.rb +35 -0
  42. data/lib/Berrycrawl/internal/types/union.rb +161 -0
  43. data/lib/Berrycrawl/internal/types/unknown.rb +15 -0
  44. data/lib/Berrycrawl/internal/types/utils.rb +116 -0
  45. data/lib/Berrycrawl/jobs/client.rb +127 -0
  46. data/lib/Berrycrawl/jobs/types/cancel_jobs_request.rb +11 -0
  47. data/lib/Berrycrawl/jobs/types/get_jobs_request.rb +15 -0
  48. data/lib/Berrycrawl/jobs/types/list_jobs_request.rb +17 -0
  49. data/lib/Berrycrawl/jobs/types/list_jobs_request_status.rb +17 -0
  50. data/lib/Berrycrawl/jobs/types/list_jobs_request_type.rb +14 -0
  51. data/lib/Berrycrawl/types/account_response.rb +11 -0
  52. data/lib/Berrycrawl/types/account_response_data.rb +21 -0
  53. data/lib/Berrycrawl/types/account_response_data_plan.rb +17 -0
  54. data/lib/Berrycrawl/types/account_response_data_queue.rb +11 -0
  55. data/lib/Berrycrawl/types/action_dto.rb +21 -0
  56. data/lib/Berrycrawl/types/action_dto_direction.rb +12 -0
  57. data/lib/Berrycrawl/types/action_dto_type.rb +18 -0
  58. data/lib/Berrycrawl/types/agent_config_dto.rb +11 -0
  59. data/lib/Berrycrawl/types/agent_config_dto_mode.rb +12 -0
  60. data/lib/Berrycrawl/types/brand_asset.rb +17 -0
  61. data/lib/Berrycrawl/types/brand_profile.rb +27 -0
  62. data/lib/Berrycrawl/types/brand_profile_colors_item.rb +11 -0
  63. data/lib/Berrycrawl/types/brand_profile_fonts_item.rb +11 -0
  64. data/lib/Berrycrawl/types/brand_profile_socials_item.rb +11 -0
  65. data/lib/Berrycrawl/types/brand_response.rb +11 -0
  66. data/lib/Berrycrawl/types/brand_response_data.rb +11 -0
  67. data/lib/Berrycrawl/types/brand_response_data_meta.rb +15 -0
  68. data/lib/Berrycrawl/types/cancel_job_response.rb +11 -0
  69. data/lib/Berrycrawl/types/cancel_job_response_data.rb +11 -0
  70. data/lib/Berrycrawl/types/change_tracking_format_dto.rb +15 -0
  71. data/lib/Berrycrawl/types/change_tracking_format_dto_type.rb +11 -0
  72. data/lib/Berrycrawl/types/crawl_dto.rb +41 -0
  73. data/lib/Berrycrawl/types/crawl_dto_sitemap.rb +13 -0
  74. data/lib/Berrycrawl/types/extract_dto.rb +29 -0
  75. data/lib/Berrycrawl/types/extract_webhook_config_dto.rb +15 -0
  76. data/lib/Berrycrawl/types/job_created_response.rb +15 -0
  77. data/lib/Berrycrawl/types/job_response.rb +11 -0
  78. data/lib/Berrycrawl/types/job_response_data.rb +37 -0
  79. data/lib/Berrycrawl/types/job_response_data_errors_item.rb +11 -0
  80. data/lib/Berrycrawl/types/job_summary.rb +29 -0
  81. data/lib/Berrycrawl/types/job_summary_type.rb +12 -0
  82. data/lib/Berrycrawl/types/json_format_dto.rb +13 -0
  83. data/lib/Berrycrawl/types/json_format_dto_type.rb +11 -0
  84. data/lib/Berrycrawl/types/list_jobs_response.rb +11 -0
  85. data/lib/Berrycrawl/types/list_jobs_response_data.rb +11 -0
  86. data/lib/Berrycrawl/types/list_webhooks_response.rb +11 -0
  87. data/lib/Berrycrawl/types/location_dto.rb +11 -0
  88. data/lib/Berrycrawl/types/map_dto.rb +23 -0
  89. data/lib/Berrycrawl/types/map_dto_sitemap.rb +13 -0
  90. data/lib/Berrycrawl/types/map_link.rb +13 -0
  91. data/lib/Berrycrawl/types/map_response.rb +15 -0
  92. data/lib/Berrycrawl/types/message_response.rb +11 -0
  93. data/lib/Berrycrawl/types/pagination.rb +15 -0
  94. data/lib/Berrycrawl/types/parse_dto.rb +11 -0
  95. data/lib/Berrycrawl/types/scrape_dto.rb +49 -0
  96. data/lib/Berrycrawl/types/scrape_dto_formats_item.rb +17 -0
  97. data/lib/Berrycrawl/types/scrape_dto_formats_item_zero.rb +18 -0
  98. data/lib/Berrycrawl/types/scrape_dto_proxy.rb +16 -0
  99. data/lib/Berrycrawl/types/scrape_metadata.rb +17 -0
  100. data/lib/Berrycrawl/types/scrape_response.rb +17 -0
  101. data/lib/Berrycrawl/types/scrape_response_credits.rb +9 -0
  102. data/lib/Berrycrawl/types/screenshot_clip_dto.rb +15 -0
  103. data/lib/Berrycrawl/types/screenshot_cookie_dto.rb +21 -0
  104. data/lib/Berrycrawl/types/screenshot_cookie_dto_same_site.rb +13 -0
  105. data/lib/Berrycrawl/types/screenshot_dto.rb +79 -0
  106. data/lib/Berrycrawl/types/screenshot_dto_color_scheme.rb +12 -0
  107. data/lib/Berrycrawl/types/screenshot_dto_device.rb +15 -0
  108. data/lib/Berrycrawl/types/screenshot_dto_format.rb +13 -0
  109. data/lib/Berrycrawl/types/screenshot_dto_full_page_algorithm.rb +13 -0
  110. data/lib/Berrycrawl/types/screenshot_dto_proxy.rb +16 -0
  111. data/lib/Berrycrawl/types/screenshot_dto_response_format.rb +12 -0
  112. data/lib/Berrycrawl/types/screenshot_dto_scale.rb +12 -0
  113. data/lib/Berrycrawl/types/screenshot_dto_wait_until.rb +13 -0
  114. data/lib/Berrycrawl/types/screenshot_location_dto.rb +11 -0
  115. data/lib/Berrycrawl/types/screenshot_viewport_dto.rb +11 -0
  116. data/lib/Berrycrawl/types/search_dto.rb +23 -0
  117. data/lib/Berrycrawl/types/search_response.rb +19 -0
  118. data/lib/Berrycrawl/types/search_response_provider.rb +11 -0
  119. data/lib/Berrycrawl/types/search_result.rb +19 -0
  120. data/lib/Berrycrawl/types/search_result_provider.rb +11 -0
  121. data/lib/Berrycrawl/types/summary_format_dto.rb +11 -0
  122. data/lib/Berrycrawl/types/summary_format_dto_type.rb +11 -0
  123. data/lib/Berrycrawl/types/test_webhook_response.rb +15 -0
  124. data/lib/Berrycrawl/types/webhook.rb +23 -0
  125. data/lib/Berrycrawl/types/webhook_config_dto.rb +15 -0
  126. data/lib/Berrycrawl/types/webhook_response.rb +11 -0
  127. data/lib/Berrycrawl/version.rb +5 -0
  128. data/lib/Berrycrawl/webhooks/client.rb +214 -0
  129. data/lib/Berrycrawl/webhooks/types/create_webhook_dto.rb +13 -0
  130. data/lib/Berrycrawl/webhooks/types/delete_webhooks_request.rb +11 -0
  131. data/lib/Berrycrawl/webhooks/types/get_webhooks_request.rb +11 -0
  132. data/lib/Berrycrawl/webhooks/types/test_webhook_dto.rb +15 -0
  133. data/lib/Berrycrawl/webhooks/types/update_webhook_dto.rb +17 -0
  134. data/lib/Berrycrawl.rb +130 -0
  135. data/reference.md +1759 -0
  136. metadata +179 -0
metadata ADDED
@@ -0,0 +1,179 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: berrycrawl
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Strawberry Labs LLC
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2026-07-20 00:00:00.000000000 Z
12
+ dependencies: []
13
+ description: The Berrycrawl Ruby library provides convenient access to the Berrycrawl
14
+ API from Ruby.
15
+ email:
16
+ executables: []
17
+ extensions: []
18
+ extra_rdoc_files: []
19
+ files:
20
+ - ".fern/metadata.json"
21
+ - ".rubocop.yml"
22
+ - CONTRIBUTING.md
23
+ - LICENSE
24
+ - README.md
25
+ - Rakefile
26
+ - custom.gemspec.rb
27
+ - lib/Berrycrawl.rb
28
+ - lib/Berrycrawl/account/client.rb
29
+ - lib/Berrycrawl/brand/client.rb
30
+ - lib/Berrycrawl/brand/types/brand_dto.rb
31
+ - lib/Berrycrawl/client.rb
32
+ - lib/Berrycrawl/environment.rb
33
+ - lib/Berrycrawl/errors/api_error.rb
34
+ - lib/Berrycrawl/errors/client_error.rb
35
+ - lib/Berrycrawl/errors/redirect_error.rb
36
+ - lib/Berrycrawl/errors/response_error.rb
37
+ - lib/Berrycrawl/errors/server_error.rb
38
+ - lib/Berrycrawl/errors/timeout_error.rb
39
+ - lib/Berrycrawl/internal/errors/constraint_error.rb
40
+ - lib/Berrycrawl/internal/errors/type_error.rb
41
+ - lib/Berrycrawl/internal/http/base_request.rb
42
+ - lib/Berrycrawl/internal/http/raw_client.rb
43
+ - lib/Berrycrawl/internal/iterators/cursor_item_iterator.rb
44
+ - lib/Berrycrawl/internal/iterators/cursor_page_iterator.rb
45
+ - lib/Berrycrawl/internal/iterators/item_iterator.rb
46
+ - lib/Berrycrawl/internal/iterators/offset_item_iterator.rb
47
+ - lib/Berrycrawl/internal/iterators/offset_page_iterator.rb
48
+ - lib/Berrycrawl/internal/json/request.rb
49
+ - lib/Berrycrawl/internal/json/serializable.rb
50
+ - lib/Berrycrawl/internal/multipart/multipart_encoder.rb
51
+ - lib/Berrycrawl/internal/multipart/multipart_form_data.rb
52
+ - lib/Berrycrawl/internal/multipart/multipart_form_data_part.rb
53
+ - lib/Berrycrawl/internal/multipart/multipart_request.rb
54
+ - lib/Berrycrawl/internal/types/array.rb
55
+ - lib/Berrycrawl/internal/types/boolean.rb
56
+ - lib/Berrycrawl/internal/types/enum.rb
57
+ - lib/Berrycrawl/internal/types/hash.rb
58
+ - lib/Berrycrawl/internal/types/model.rb
59
+ - lib/Berrycrawl/internal/types/model/field.rb
60
+ - lib/Berrycrawl/internal/types/type.rb
61
+ - lib/Berrycrawl/internal/types/union.rb
62
+ - lib/Berrycrawl/internal/types/unknown.rb
63
+ - lib/Berrycrawl/internal/types/utils.rb
64
+ - lib/Berrycrawl/jobs/client.rb
65
+ - lib/Berrycrawl/jobs/types/cancel_jobs_request.rb
66
+ - lib/Berrycrawl/jobs/types/get_jobs_request.rb
67
+ - lib/Berrycrawl/jobs/types/list_jobs_request.rb
68
+ - lib/Berrycrawl/jobs/types/list_jobs_request_status.rb
69
+ - lib/Berrycrawl/jobs/types/list_jobs_request_type.rb
70
+ - lib/Berrycrawl/types/account_response.rb
71
+ - lib/Berrycrawl/types/account_response_data.rb
72
+ - lib/Berrycrawl/types/account_response_data_plan.rb
73
+ - lib/Berrycrawl/types/account_response_data_queue.rb
74
+ - lib/Berrycrawl/types/action_dto.rb
75
+ - lib/Berrycrawl/types/action_dto_direction.rb
76
+ - lib/Berrycrawl/types/action_dto_type.rb
77
+ - lib/Berrycrawl/types/agent_config_dto.rb
78
+ - lib/Berrycrawl/types/agent_config_dto_mode.rb
79
+ - lib/Berrycrawl/types/brand_asset.rb
80
+ - lib/Berrycrawl/types/brand_profile.rb
81
+ - lib/Berrycrawl/types/brand_profile_colors_item.rb
82
+ - lib/Berrycrawl/types/brand_profile_fonts_item.rb
83
+ - lib/Berrycrawl/types/brand_profile_socials_item.rb
84
+ - lib/Berrycrawl/types/brand_response.rb
85
+ - lib/Berrycrawl/types/brand_response_data.rb
86
+ - lib/Berrycrawl/types/brand_response_data_meta.rb
87
+ - lib/Berrycrawl/types/cancel_job_response.rb
88
+ - lib/Berrycrawl/types/cancel_job_response_data.rb
89
+ - lib/Berrycrawl/types/change_tracking_format_dto.rb
90
+ - lib/Berrycrawl/types/change_tracking_format_dto_type.rb
91
+ - lib/Berrycrawl/types/crawl_dto.rb
92
+ - lib/Berrycrawl/types/crawl_dto_sitemap.rb
93
+ - lib/Berrycrawl/types/extract_dto.rb
94
+ - lib/Berrycrawl/types/extract_webhook_config_dto.rb
95
+ - lib/Berrycrawl/types/job_created_response.rb
96
+ - lib/Berrycrawl/types/job_response.rb
97
+ - lib/Berrycrawl/types/job_response_data.rb
98
+ - lib/Berrycrawl/types/job_response_data_errors_item.rb
99
+ - lib/Berrycrawl/types/job_summary.rb
100
+ - lib/Berrycrawl/types/job_summary_type.rb
101
+ - lib/Berrycrawl/types/json_format_dto.rb
102
+ - lib/Berrycrawl/types/json_format_dto_type.rb
103
+ - lib/Berrycrawl/types/list_jobs_response.rb
104
+ - lib/Berrycrawl/types/list_jobs_response_data.rb
105
+ - lib/Berrycrawl/types/list_webhooks_response.rb
106
+ - lib/Berrycrawl/types/location_dto.rb
107
+ - lib/Berrycrawl/types/map_dto.rb
108
+ - lib/Berrycrawl/types/map_dto_sitemap.rb
109
+ - lib/Berrycrawl/types/map_link.rb
110
+ - lib/Berrycrawl/types/map_response.rb
111
+ - lib/Berrycrawl/types/message_response.rb
112
+ - lib/Berrycrawl/types/pagination.rb
113
+ - lib/Berrycrawl/types/parse_dto.rb
114
+ - lib/Berrycrawl/types/scrape_dto.rb
115
+ - lib/Berrycrawl/types/scrape_dto_formats_item.rb
116
+ - lib/Berrycrawl/types/scrape_dto_formats_item_zero.rb
117
+ - lib/Berrycrawl/types/scrape_dto_proxy.rb
118
+ - lib/Berrycrawl/types/scrape_metadata.rb
119
+ - lib/Berrycrawl/types/scrape_response.rb
120
+ - lib/Berrycrawl/types/scrape_response_credits.rb
121
+ - lib/Berrycrawl/types/screenshot_clip_dto.rb
122
+ - lib/Berrycrawl/types/screenshot_cookie_dto.rb
123
+ - lib/Berrycrawl/types/screenshot_cookie_dto_same_site.rb
124
+ - lib/Berrycrawl/types/screenshot_dto.rb
125
+ - lib/Berrycrawl/types/screenshot_dto_color_scheme.rb
126
+ - lib/Berrycrawl/types/screenshot_dto_device.rb
127
+ - lib/Berrycrawl/types/screenshot_dto_format.rb
128
+ - lib/Berrycrawl/types/screenshot_dto_full_page_algorithm.rb
129
+ - lib/Berrycrawl/types/screenshot_dto_proxy.rb
130
+ - lib/Berrycrawl/types/screenshot_dto_response_format.rb
131
+ - lib/Berrycrawl/types/screenshot_dto_scale.rb
132
+ - lib/Berrycrawl/types/screenshot_dto_wait_until.rb
133
+ - lib/Berrycrawl/types/screenshot_location_dto.rb
134
+ - lib/Berrycrawl/types/screenshot_viewport_dto.rb
135
+ - lib/Berrycrawl/types/search_dto.rb
136
+ - lib/Berrycrawl/types/search_response.rb
137
+ - lib/Berrycrawl/types/search_response_provider.rb
138
+ - lib/Berrycrawl/types/search_result.rb
139
+ - lib/Berrycrawl/types/search_result_provider.rb
140
+ - lib/Berrycrawl/types/summary_format_dto.rb
141
+ - lib/Berrycrawl/types/summary_format_dto_type.rb
142
+ - lib/Berrycrawl/types/test_webhook_response.rb
143
+ - lib/Berrycrawl/types/webhook.rb
144
+ - lib/Berrycrawl/types/webhook_config_dto.rb
145
+ - lib/Berrycrawl/types/webhook_response.rb
146
+ - lib/Berrycrawl/version.rb
147
+ - lib/Berrycrawl/webhooks/client.rb
148
+ - lib/Berrycrawl/webhooks/types/create_webhook_dto.rb
149
+ - lib/Berrycrawl/webhooks/types/delete_webhooks_request.rb
150
+ - lib/Berrycrawl/webhooks/types/get_webhooks_request.rb
151
+ - lib/Berrycrawl/webhooks/types/test_webhook_dto.rb
152
+ - lib/Berrycrawl/webhooks/types/update_webhook_dto.rb
153
+ - reference.md
154
+ homepage: https://docs.berrycrawl.com
155
+ licenses:
156
+ - Apache-2.0
157
+ metadata:
158
+ source_code_uri: https://github.com/strawberry-labs/berrycrawl-ruby
159
+ rubygems_mfa_required: 'true'
160
+ post_install_message:
161
+ rdoc_options: []
162
+ require_paths:
163
+ - lib
164
+ required_ruby_version: !ruby/object:Gem::Requirement
165
+ requirements:
166
+ - - ">="
167
+ - !ruby/object:Gem::Version
168
+ version: 3.3.0
169
+ required_rubygems_version: !ruby/object:Gem::Requirement
170
+ requirements:
171
+ - - ">="
172
+ - !ruby/object:Gem::Version
173
+ version: '0'
174
+ requirements: []
175
+ rubygems_version: 3.5.22
176
+ signing_key:
177
+ specification_version: 4
178
+ summary: Ruby client library for the Berrycrawl API
179
+ test_files: []