ruby_shopify_api 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (351) hide show
  1. checksums.yaml +7 -0
  2. data/.document +5 -0
  3. data/.github/CODEOWNERS +1 -0
  4. data/.github/ISSUE_TEMPLATE.md +36 -0
  5. data/.github/probots.yml +2 -0
  6. data/.github/workflows/build.yml +43 -0
  7. data/.gitignore +15 -0
  8. data/.rubocop.yml +28 -0
  9. data/.rubocop_todo.yml +75 -0
  10. data/CHANGELOG-OLD.md +501 -0
  11. data/CHANGELOG.md +5 -0
  12. data/CONTRIBUTING.md +8 -0
  13. data/CONTRIBUTORS +3 -0
  14. data/Gemfile +10 -0
  15. data/Gemfile.lock +151 -0
  16. data/Gemfile_ar41 +5 -0
  17. data/Gemfile_ar50 +5 -0
  18. data/Gemfile_ar51 +5 -0
  19. data/Gemfile_ar60 +5 -0
  20. data/Gemfile_ar_main +5 -0
  21. data/LICENSE +20 -0
  22. data/README.md +649 -0
  23. data/RELEASING +17 -0
  24. data/Rakefile +55 -0
  25. data/SECURITY.md +59 -0
  26. data/dev.yml +11 -0
  27. data/docker-compose.yml +13 -0
  28. data/docs/_config.yml +1 -0
  29. data/docs/_includes/footer.html +28 -0
  30. data/docs/_includes/head.html +28 -0
  31. data/docs/_layouts/index.html +57 -0
  32. data/docs/graphql.md +241 -0
  33. data/docs/index.md +639 -0
  34. data/lib/active_resource/connection_ext.rb +11 -0
  35. data/lib/active_resource/detailed_log_subscriber.rb +55 -0
  36. data/lib/active_resource/json_errors.rb +37 -0
  37. data/lib/shopify_api/api_access.rb +57 -0
  38. data/lib/shopify_api/api_version.rb +206 -0
  39. data/lib/shopify_api/connection.rb +36 -0
  40. data/lib/shopify_api/countable.rb +15 -0
  41. data/lib/shopify_api/disable_prefix_check.rb +31 -0
  42. data/lib/shopify_api/events.rb +8 -0
  43. data/lib/shopify_api/graphql/http_client.rb +22 -0
  44. data/lib/shopify_api/graphql/railtie.rb +17 -0
  45. data/lib/shopify_api/graphql/task.rake +100 -0
  46. data/lib/shopify_api/graphql.rb +103 -0
  47. data/lib/shopify_api/hmac_params.rb +33 -0
  48. data/lib/shopify_api/limits.rb +77 -0
  49. data/lib/shopify_api/message_enricher.rb +25 -0
  50. data/lib/shopify_api/meta.rb +14 -0
  51. data/lib/shopify_api/metafields.rb +21 -0
  52. data/lib/shopify_api/paginated_collection.rb +69 -0
  53. data/lib/shopify_api/pagination_link_headers.rb +34 -0
  54. data/lib/shopify_api/resources/abandoned_checkout.rb +7 -0
  55. data/lib/shopify_api/resources/access_scope.rb +10 -0
  56. data/lib/shopify_api/resources/access_token.rb +9 -0
  57. data/lib/shopify_api/resources/address.rb +5 -0
  58. data/lib/shopify_api/resources/announcement.rb +5 -0
  59. data/lib/shopify_api/resources/api_permission.rb +9 -0
  60. data/lib/shopify_api/resources/application_charge.rb +16 -0
  61. data/lib/shopify_api/resources/application_credit.rb +5 -0
  62. data/lib/shopify_api/resources/array_base.rb +13 -0
  63. data/lib/shopify_api/resources/article.rb +22 -0
  64. data/lib/shopify_api/resources/asset.rb +101 -0
  65. data/lib/shopify_api/resources/assigned_fulfillment_order.rb +16 -0
  66. data/lib/shopify_api/resources/base.rb +166 -0
  67. data/lib/shopify_api/resources/billing_address.rb +5 -0
  68. data/lib/shopify_api/resources/blog.rb +11 -0
  69. data/lib/shopify_api/resources/carrier_service.rb +5 -0
  70. data/lib/shopify_api/resources/cart.rb +5 -0
  71. data/lib/shopify_api/resources/checkout.rb +30 -0
  72. data/lib/shopify_api/resources/collect.rb +7 -0
  73. data/lib/shopify_api/resources/collection.rb +14 -0
  74. data/lib/shopify_api/resources/collection_listing.rb +19 -0
  75. data/lib/shopify_api/resources/collection_publication.rb +10 -0
  76. data/lib/shopify_api/resources/comment.rb +24 -0
  77. data/lib/shopify_api/resources/country.rb +5 -0
  78. data/lib/shopify_api/resources/currency.rb +6 -0
  79. data/lib/shopify_api/resources/custom_collection.rb +20 -0
  80. data/lib/shopify_api/resources/customer.rb +30 -0
  81. data/lib/shopify_api/resources/customer_group.rb +6 -0
  82. data/lib/shopify_api/resources/customer_invite.rb +5 -0
  83. data/lib/shopify_api/resources/customer_saved_search.rb +12 -0
  84. data/lib/shopify_api/resources/discount_code.rb +10 -0
  85. data/lib/shopify_api/resources/discount_code_batch.rb +34 -0
  86. data/lib/shopify_api/resources/draft_order.rb +15 -0
  87. data/lib/shopify_api/resources/draft_order_invoice.rb +5 -0
  88. data/lib/shopify_api/resources/event.rb +9 -0
  89. data/lib/shopify_api/resources/fulfillment.rb +56 -0
  90. data/lib/shopify_api/resources/fulfillment_event.rb +16 -0
  91. data/lib/shopify_api/resources/fulfillment_order.rb +151 -0
  92. data/lib/shopify_api/resources/fulfillment_order_locations_for_move.rb +5 -0
  93. data/lib/shopify_api/resources/fulfillment_request.rb +16 -0
  94. data/lib/shopify_api/resources/fulfillment_service.rb +5 -0
  95. data/lib/shopify_api/resources/fulfillment_v2.rb +21 -0
  96. data/lib/shopify_api/resources/gift_card.rb +8 -0
  97. data/lib/shopify_api/resources/image.rb +17 -0
  98. data/lib/shopify_api/resources/inventory_item.rb +6 -0
  99. data/lib/shopify_api/resources/inventory_level.rb +54 -0
  100. data/lib/shopify_api/resources/line_item.rb +15 -0
  101. data/lib/shopify_api/resources/location.rb +8 -0
  102. data/lib/shopify_api/resources/marketing_event.rb +11 -0
  103. data/lib/shopify_api/resources/metafield.rb +14 -0
  104. data/lib/shopify_api/resources/note_attribute.rb +5 -0
  105. data/lib/shopify_api/resources/option.rb +5 -0
  106. data/lib/shopify_api/resources/order.rb +44 -0
  107. data/lib/shopify_api/resources/order_risk.rb +9 -0
  108. data/lib/shopify_api/resources/page.rb +7 -0
  109. data/lib/shopify_api/resources/payment.rb +7 -0
  110. data/lib/shopify_api/resources/payment_details.rb +5 -0
  111. data/lib/shopify_api/resources/ping.rb +3 -0
  112. data/lib/shopify_api/resources/policy.rb +8 -0
  113. data/lib/shopify_api/resources/price_rule.rb +8 -0
  114. data/lib/shopify_api/resources/product.rb +59 -0
  115. data/lib/shopify_api/resources/product_listing.rb +17 -0
  116. data/lib/shopify_api/resources/product_publication.rb +10 -0
  117. data/lib/shopify_api/resources/province.rb +6 -0
  118. data/lib/shopify_api/resources/publication.rb +5 -0
  119. data/lib/shopify_api/resources/receipt.rb +5 -0
  120. data/lib/shopify_api/resources/recurring_application_charge.rb +34 -0
  121. data/lib/shopify_api/resources/redirect.rb +5 -0
  122. data/lib/shopify_api/resources/refund.rb +15 -0
  123. data/lib/shopify_api/resources/report.rb +5 -0
  124. data/lib/shopify_api/resources/resource_feedback.rb +19 -0
  125. data/lib/shopify_api/resources/rule.rb +5 -0
  126. data/lib/shopify_api/resources/script_tag.rb +5 -0
  127. data/lib/shopify_api/resources/shipping_address.rb +5 -0
  128. data/lib/shopify_api/resources/shipping_line.rb +5 -0
  129. data/lib/shopify_api/resources/shipping_rate.rb +7 -0
  130. data/lib/shopify_api/resources/shipping_zone.rb +5 -0
  131. data/lib/shopify_api/resources/shop.rb +26 -0
  132. data/lib/shopify_api/resources/smart_collection.rb +15 -0
  133. data/lib/shopify_api/resources/storefront_access_token.rb +5 -0
  134. data/lib/shopify_api/resources/tax_line.rb +5 -0
  135. data/lib/shopify_api/resources/tax_service.rb +5 -0
  136. data/lib/shopify_api/resources/tender_transaction.rb +6 -0
  137. data/lib/shopify_api/resources/theme.rb +5 -0
  138. data/lib/shopify_api/resources/transaction.rb +6 -0
  139. data/lib/shopify_api/resources/usage_charge.rb +6 -0
  140. data/lib/shopify_api/resources/user.rb +5 -0
  141. data/lib/shopify_api/resources/variant.rb +43 -0
  142. data/lib/shopify_api/resources/webhook.rb +5 -0
  143. data/lib/shopify_api/resources.rb +4 -0
  144. data/lib/shopify_api/session.rb +203 -0
  145. data/lib/shopify_api/version.rb +4 -0
  146. data/lib/shopify_api.rb +45 -0
  147. data/lib/verify_docs.rb +8 -0
  148. data/service.yml +2 -0
  149. data/shipit.rubygems.yml +1 -0
  150. data/shopify_api.gemspec +47 -0
  151. data/test/abandoned_checkouts_test.rb +29 -0
  152. data/test/access_scope_test.rb +23 -0
  153. data/test/access_token_test.rb +20 -0
  154. data/test/active_resource/json_errors_test.rb +19 -0
  155. data/test/api_access_test.rb +153 -0
  156. data/test/api_permission_test.rb +9 -0
  157. data/test/api_version_test.rb +157 -0
  158. data/test/application_charge_test.rb +82 -0
  159. data/test/application_credit_test.rb +36 -0
  160. data/test/article_test.rb +72 -0
  161. data/test/asset_test.rb +26 -0
  162. data/test/assigned_fulfillment_order_test.rb +78 -0
  163. data/test/base_test.rb +213 -0
  164. data/test/blog_test.rb +9 -0
  165. data/test/carrier_service_test.rb +18 -0
  166. data/test/cart_test.rb +14 -0
  167. data/test/checkouts_test.rb +77 -0
  168. data/test/collect_test.rb +10 -0
  169. data/test/collection_listing_test.rb +84 -0
  170. data/test/collection_publication_test.rb +40 -0
  171. data/test/collection_test.rb +50 -0
  172. data/test/countable_test.rb +14 -0
  173. data/test/currency_test.rb +21 -0
  174. data/test/custom_collection_test.rb +10 -0
  175. data/test/customer_saved_search_test.rb +37 -0
  176. data/test/customer_test.rb +58 -0
  177. data/test/detailed_log_subscriber_test.rb +143 -0
  178. data/test/discount_code_batch_test.rb +41 -0
  179. data/test/discount_code_test.rb +59 -0
  180. data/test/draft_order_test.rb +167 -0
  181. data/test/fixtures/abandoned_checkout.json +184 -0
  182. data/test/fixtures/abandoned_checkouts.json +186 -0
  183. data/test/fixtures/access_scopes.json +10 -0
  184. data/test/fixtures/access_token_delegate.json +4 -0
  185. data/test/fixtures/api_versions.json +38 -0
  186. data/test/fixtures/apis.json +42 -0
  187. data/test/fixtures/application_charge.json +16 -0
  188. data/test/fixtures/application_charges.json +57 -0
  189. data/test/fixtures/application_credit.json +12 -0
  190. data/test/fixtures/application_credits.json +24 -0
  191. data/test/fixtures/article.json +15 -0
  192. data/test/fixtures/articles.json +39 -0
  193. data/test/fixtures/asset.json +9 -0
  194. data/test/fixtures/assets.json +136 -0
  195. data/test/fixtures/assigned_fulfillment_orders.json +80 -0
  196. data/test/fixtures/authors.json +1 -0
  197. data/test/fixtures/blog.json +13 -0
  198. data/test/fixtures/blogs.json +13 -0
  199. data/test/fixtures/carrier_service.json +9 -0
  200. data/test/fixtures/carts.json +43 -0
  201. data/test/fixtures/checkout.json +160 -0
  202. data/test/fixtures/checkouts.json +162 -0
  203. data/test/fixtures/collect.json +12 -0
  204. data/test/fixtures/collection.json +17 -0
  205. data/test/fixtures/collection_listing.json +11 -0
  206. data/test/fixtures/collection_listing_product_ids.json +1 -0
  207. data/test/fixtures/collection_listing_product_ids2.json +1 -0
  208. data/test/fixtures/collection_listings.json +13 -0
  209. data/test/fixtures/collection_products.json +47 -0
  210. data/test/fixtures/collection_publication.json +11 -0
  211. data/test/fixtures/collection_publications.json +13 -0
  212. data/test/fixtures/currencies.json +25 -0
  213. data/test/fixtures/custom_collection.json +17 -0
  214. data/test/fixtures/customer_invite.json +9 -0
  215. data/test/fixtures/customer_saved_search.json +9 -0
  216. data/test/fixtures/customer_saved_search_customers.json +60 -0
  217. data/test/fixtures/customers.json +59 -0
  218. data/test/fixtures/customers_account_activation_url.json +3 -0
  219. data/test/fixtures/customers_search.json +60 -0
  220. data/test/fixtures/discount_code.json +10 -0
  221. data/test/fixtures/discount_code_batch.json +14 -0
  222. data/test/fixtures/discount_code_batch_discount_codes.json +21 -0
  223. data/test/fixtures/discount_codes.json +12 -0
  224. data/test/fixtures/draft_order.json +159 -0
  225. data/test/fixtures/draft_order_completed.json +159 -0
  226. data/test/fixtures/draft_order_invoice.json +9 -0
  227. data/test/fixtures/draft_orders.json +161 -0
  228. data/test/fixtures/engagement.json +15 -0
  229. data/test/fixtures/events.json +31 -0
  230. data/test/fixtures/fulfillment.json +49 -0
  231. data/test/fixtures/fulfillment_event.json +12 -0
  232. data/test/fixtures/fulfillment_order.json +39 -0
  233. data/test/fixtures/fulfillment_order_locations_for_move.json +18 -0
  234. data/test/fixtures/fulfillment_orders.json +80 -0
  235. data/test/fixtures/fulfillment_request.json +28 -0
  236. data/test/fixtures/fulfillment_service.json +10 -0
  237. data/test/fixtures/fulfillments.json +53 -0
  238. data/test/fixtures/gift_card.json +20 -0
  239. data/test/fixtures/gift_card_disabled.json +20 -0
  240. data/test/fixtures/graphql/2019-10.json +1083 -0
  241. data/test/fixtures/graphql/dummy_schema.rb +16 -0
  242. data/test/fixtures/graphql/unstable.json +1083 -0
  243. data/test/fixtures/image.json +10 -0
  244. data/test/fixtures/images.json +20 -0
  245. data/test/fixtures/inventory_level.json +7 -0
  246. data/test/fixtures/inventory_levels.json +24 -0
  247. data/test/fixtures/marketing_event.json +28 -0
  248. data/test/fixtures/marketing_events.json +54 -0
  249. data/test/fixtures/metafield.json +12 -0
  250. data/test/fixtures/metafields.json +34 -0
  251. data/test/fixtures/order.json +297 -0
  252. data/test/fixtures/order_risk.json +14 -0
  253. data/test/fixtures/order_risks.json +28 -0
  254. data/test/fixtures/order_with_properties.json +373 -0
  255. data/test/fixtures/orders.json +299 -0
  256. data/test/fixtures/payment.json +7 -0
  257. data/test/fixtures/payments.json +9 -0
  258. data/test/fixtures/ping/conversation.json +1 -0
  259. data/test/fixtures/ping/failed_delivery_confirmation.json +1 -0
  260. data/test/fixtures/ping/message.json +1 -0
  261. data/test/fixtures/ping/successful_delivery_confirmation.json +1 -0
  262. data/test/fixtures/policies.json +8 -0
  263. data/test/fixtures/price_rule.json +27 -0
  264. data/test/fixtures/price_rules.json +28 -0
  265. data/test/fixtures/product.json +116 -0
  266. data/test/fixtures/product_listing.json +86 -0
  267. data/test/fixtures/product_listing_product_ids.json +1 -0
  268. data/test/fixtures/product_listing_product_ids2.json +1 -0
  269. data/test/fixtures/product_listings.json +174 -0
  270. data/test/fixtures/product_publication.json +11 -0
  271. data/test/fixtures/product_publications.json +13 -0
  272. data/test/fixtures/publications.json +9 -0
  273. data/test/fixtures/recurring_application_charge.json +22 -0
  274. data/test/fixtures/recurring_application_charge_adjustment.json +5 -0
  275. data/test/fixtures/recurring_application_charges.json +106 -0
  276. data/test/fixtures/redirect.json +7 -0
  277. data/test/fixtures/refund.json +112 -0
  278. data/test/fixtures/report.json +9 -0
  279. data/test/fixtures/reports.json +11 -0
  280. data/test/fixtures/script_tag.json +10 -0
  281. data/test/fixtures/script_tags.json +18 -0
  282. data/test/fixtures/shipping_rates.json +12 -0
  283. data/test/fixtures/shipping_zones.json +315 -0
  284. data/test/fixtures/shop.json +26 -0
  285. data/test/fixtures/smart_collection.json +21 -0
  286. data/test/fixtures/smart_collection_products.json +155 -0
  287. data/test/fixtures/storefront_access_token.json +9 -0
  288. data/test/fixtures/storefront_access_tokens.json +18 -0
  289. data/test/fixtures/tags.json +1 -0
  290. data/test/fixtures/tax_service.json +9 -0
  291. data/test/fixtures/tender_transactions.json +52 -0
  292. data/test/fixtures/transaction.json +29 -0
  293. data/test/fixtures/usage_charge.json +11 -0
  294. data/test/fixtures/usage_charges.json +23 -0
  295. data/test/fixtures/user.json +21 -0
  296. data/test/fixtures/users.json +42 -0
  297. data/test/fixtures/variant.json +23 -0
  298. data/test/fixtures/variants.json +88 -0
  299. data/test/fixtures/webhook.json +10 -0
  300. data/test/fixtures/webhooks.json +18 -0
  301. data/test/fulfillment_event_test.rb +74 -0
  302. data/test/fulfillment_order_test.rb +530 -0
  303. data/test/fulfillment_order_test_helper.rb +8 -0
  304. data/test/fulfillment_request_test.rb +35 -0
  305. data/test/fulfillment_service_test.rb +18 -0
  306. data/test/fulfillment_test.rb +239 -0
  307. data/test/fulfillment_v2_test.rb +66 -0
  308. data/test/gift_card_test.rb +24 -0
  309. data/test/graphql/http_client_test.rb +26 -0
  310. data/test/graphql_test.rb +190 -0
  311. data/test/hmac_params_test.rb +25 -0
  312. data/test/image_test.rb +41 -0
  313. data/test/inventory_level_test.rb +68 -0
  314. data/test/lib/webmock_extensions/last_request.rb +16 -0
  315. data/test/limits_test.rb +39 -0
  316. data/test/location_test.rb +15 -0
  317. data/test/marketing_event_test.rb +68 -0
  318. data/test/message_enricher_test.rb +45 -0
  319. data/test/meta_test.rb +47 -0
  320. data/test/metafield_test.rb +56 -0
  321. data/test/order_risk_test.rb +47 -0
  322. data/test/order_test.rb +140 -0
  323. data/test/pagination_test.rb +290 -0
  324. data/test/payment_test.rb +19 -0
  325. data/test/policy_test.rb +20 -0
  326. data/test/price_rule_test.rb +70 -0
  327. data/test/product_listing_test.rb +97 -0
  328. data/test/product_publication_test.rb +40 -0
  329. data/test/product_test.rb +111 -0
  330. data/test/publication_test.rb +12 -0
  331. data/test/recurring_application_charge_test.rb +204 -0
  332. data/test/redirect_test.rb +10 -0
  333. data/test/refund_test.rb +37 -0
  334. data/test/report_test.rb +37 -0
  335. data/test/resource_feedback_test.rb +43 -0
  336. data/test/script_tag_test.rb +31 -0
  337. data/test/session_test.rb +640 -0
  338. data/test/shipping_rate_test.rb +17 -0
  339. data/test/shipping_zone_test.rb +11 -0
  340. data/test/shop_test.rb +82 -0
  341. data/test/smart_collection_test.rb +11 -0
  342. data/test/storefront_access_token_test.rb +30 -0
  343. data/test/tax_service_test.rb +12 -0
  344. data/test/tender_transaction_test.rb +18 -0
  345. data/test/test_helper.rb +126 -0
  346. data/test/transaction_test.rb +18 -0
  347. data/test/usage_charge_test.rb +25 -0
  348. data/test/user_test.rb +18 -0
  349. data/test/variant_test.rb +73 -0
  350. data/test/webhook_test.rb +24 -0
  351. metadata +555 -0
@@ -0,0 +1,55 @@
1
+ # frozen_string_literal: true
2
+ module ActiveResource
3
+ class DetailedLogSubscriber < ActiveSupport::LogSubscriber
4
+ VERSION_EOL_WARNING_HEADER = 'x-shopify-api-version-warning'
5
+ VERSION_DEPRECATION_HEADER = 'x-shopify-api-deprecated-reason'
6
+ SHOPIFY_ACCESS_TOKEN = 'X-Shopify-Access-Token'
7
+ FILTERED = '[FILTERED]'
8
+
9
+ def request(event)
10
+ log_request_response_details(event)
11
+ warn_on_deprecated_header_or_version_eol_header(event)
12
+ end
13
+
14
+ def logger
15
+ ActiveResource::Base.logger
16
+ end
17
+
18
+ private
19
+
20
+ def log_request_response_details(event)
21
+ data = event.payload[:data]
22
+ headers = data.extract_options!
23
+ headers[SHOPIFY_ACCESS_TOKEN] = FILTERED
24
+ request_body = data.first
25
+
26
+ info("Request:\n#{request_body}") if request_body
27
+ info("Headers: #{headers.inspect}")
28
+ info("Response:\n#{event.payload[:response].body}")
29
+ end
30
+
31
+ def warn_on_deprecated_header_or_version_eol_header(event)
32
+ payload = event.payload
33
+
34
+ payload[:response].each do |header_name, header_value|
35
+ case header_name.downcase
36
+ when VERSION_DEPRECATION_HEADER
37
+ warning_message = <<-MSG
38
+ [DEPRECATED] ShopifyAPI made a call to #{payload[:method].upcase} #{payload[:path]}, and this call made
39
+ use of a deprecated endpoint, behaviour, or parameter. See #{header_value} for more details.
40
+ MSG
41
+
42
+ warn(warning_message)
43
+
44
+ when VERSION_EOL_WARNING_HEADER
45
+ warning_message = <<-MSG
46
+ [API Version Warning] ShopifyAPI made a call to #{payload[:method].upcase} #{payload[:path]}, and this call used
47
+ an API version that is unsupported or will become unsupported within 30 days. See #{header_value} for more details.
48
+ MSG
49
+
50
+ warn(warning_message)
51
+ end
52
+ end
53
+ end
54
+ end
55
+ end
@@ -0,0 +1,37 @@
1
+ # frozen_string_literal: true
2
+ require 'active_resource/base'
3
+
4
+ module ActiveResource
5
+ class Errors < ActiveModel::Errors
6
+ def from_json(json, save_cache = false)
7
+ data =
8
+ begin
9
+ ActiveSupport::JSON.decode(json)['errors'] || {}
10
+ rescue
11
+ {}
12
+ end
13
+ case data
14
+ when String
15
+ from_string(data, save_cache)
16
+ else
17
+ from_hash(data, save_cache)
18
+ end
19
+ end
20
+
21
+ def from_hash(messages, save_cache = false)
22
+ clear unless save_cache
23
+
24
+ messages.each do |key, errors|
25
+ errors.each do |error|
26
+ add(key, error)
27
+ end
28
+ end
29
+ end
30
+
31
+ def from_string(error, save_cache = false)
32
+ clear unless save_cache
33
+
34
+ add(:base, error)
35
+ end
36
+ end
37
+ end
@@ -0,0 +1,57 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ShopifyAPI
4
+ class ApiAccess
5
+ SCOPE_DELIMITER = ','
6
+
7
+ def initialize(scope_names)
8
+ if scope_names.is_a?(String)
9
+ scope_names = scope_names.to_s.split(SCOPE_DELIMITER)
10
+ end
11
+
12
+ store_scopes(scope_names)
13
+ end
14
+
15
+ def covers?(scopes)
16
+ scopes.compressed_scopes <= expanded_scopes
17
+ end
18
+
19
+ def to_s
20
+ to_a.join(SCOPE_DELIMITER)
21
+ end
22
+
23
+ def to_a
24
+ compressed_scopes.to_a
25
+ end
26
+
27
+ def ==(other)
28
+ other.class == self.class &&
29
+ compressed_scopes == other.compressed_scopes
30
+ end
31
+
32
+ alias :eql? :==
33
+
34
+ def hash
35
+ compressed_scopes.hash
36
+ end
37
+
38
+ protected
39
+
40
+ attr_reader :compressed_scopes, :expanded_scopes
41
+
42
+ private
43
+
44
+ def store_scopes(scope_names)
45
+ scopes = scope_names.map(&:strip).reject(&:empty?).to_set
46
+ implied_scopes = scopes.map { |scope| implied_scope(scope) }.compact
47
+
48
+ @compressed_scopes = scopes - implied_scopes
49
+ @expanded_scopes = scopes + implied_scopes
50
+ end
51
+
52
+ def implied_scope(scope)
53
+ is_write_scope = scope =~ /\A(unauthenticated_)?write_(.*)\z/
54
+ "#{$1}read_#{$2}" if is_write_scope
55
+ end
56
+ end
57
+ end
@@ -0,0 +1,206 @@
1
+ # frozen_string_literal: true
2
+ module ShopifyAPI
3
+ class ApiVersion
4
+ class UnknownVersion < StandardError; end
5
+ class ApiVersionNotSetError < StandardError; end
6
+ include Comparable
7
+
8
+ UNSTABLE_HANDLE = 'unstable'
9
+ HANDLE_FORMAT = /((\d{4}-\d{2})|#{UNSTABLE_HANDLE})/.freeze
10
+ UNSTABLE_AS_DATE = Time.utc(3000, 1, 1)
11
+ API_PREFIX = '/admin/api/'
12
+ LOOKUP_MODES = [:raise_on_unknown, :define_on_unknown].freeze
13
+
14
+ class << self
15
+ attr_reader :versions
16
+
17
+ def version_lookup_mode
18
+ @version_lookup_mode ||= :define_on_unknown
19
+ end
20
+
21
+ def version_lookup_mode=(mode)
22
+ raise ArgumentError, "Mode must be one of #{LOOKUP_MODES}" unless LOOKUP_MODES.include?(mode)
23
+ sanitize_known_versions if mode == :raise_on_unknown
24
+ @version_lookup_mode = mode
25
+ end
26
+
27
+ def find_version(version_or_handle)
28
+ raise ArgumentError, "NullVersion is not a valid version or version handle." if version_or_handle == NullVersion
29
+ return version_or_handle if version_or_handle.is_a?(ApiVersion)
30
+ handle = version_or_handle.to_s
31
+ @versions ||= {}
32
+ @versions.fetch(handle) do
33
+ if @version_lookup_mode == :raise_on_unknown
34
+ raise UnknownVersion, unknown_version_error_message(handle)
35
+ else
36
+ add_to_known_versions(ApiVersion.new(handle: handle))
37
+ end
38
+ end
39
+ end
40
+
41
+ def coerce_to_version(version_or_handle)
42
+ warn(
43
+ '[DEPRECATED] ShopifyAPI::ApiVersion.coerce_to_version be removed in a future version. ' \
44
+ 'Use `find_version` instead.'
45
+ )
46
+ find_version(version_or_handle)
47
+ end
48
+
49
+ def fetch_known_versions
50
+ @versions = Meta.admin_versions.map do |version|
51
+ [version.handle, ApiVersion.new(version.attributes.merge(verified: version.persisted?))]
52
+ end.to_h
53
+ end
54
+
55
+ def define_known_versions
56
+ warn(
57
+ '[DEPRECATED] ShopifyAPI::ApiVersion.define_known_versions is deprecated and will be ' \
58
+ 'removed in a future version. Use `fetch_known_versions` instead.'
59
+ )
60
+ fetch_known_versions
61
+ end
62
+
63
+ def add_to_known_versions(version)
64
+ @versions[version.handle] = version
65
+ end
66
+
67
+ def clear_known_versions
68
+ @versions = {}
69
+ end
70
+
71
+ def clear_defined_versions
72
+ warn(
73
+ '[DEPRECATED] ShopifyAPI::ApiVersion.clear_defined_versions is deprecated and will be ' \
74
+ 'removed in a future version. Use `clear_known_versions` instead.'
75
+ )
76
+ clear_known_versions
77
+ end
78
+
79
+ def latest_stable_version
80
+ warn(
81
+ '[DEPRECATED] ShopifyAPI::ApiVersion.latest_stable_version is deprecated and will be ' \
82
+ 'removed in a future version.'
83
+ )
84
+ versions.values.find(&:latest_supported?)
85
+ end
86
+
87
+ private
88
+
89
+ def sanitize_known_versions
90
+ return if @versions.nil?
91
+ @versions = @versions.keys.map do |handle|
92
+ next unless @versions[handle].verified?
93
+ [handle, @versions[handle]]
94
+ end.compact.to_h
95
+ end
96
+
97
+ def unknown_version_error_message(handle)
98
+ msg = "ApiVersion.version_lookup_mode is set to `:raise_on_unknown`. \n"
99
+ return msg + "No versions defined. You must call `ApiVersion.fetch_known_versions` first." if @versions.empty?
100
+ msg + "`#{handle}` is not in the defined version set. Available versions: #{@versions.keys}"
101
+ end
102
+ end
103
+
104
+ attr_reader :handle, :display_name, :supported, :latest_supported, :verified
105
+
106
+ def initialize(attributes)
107
+ attributes = ActiveSupport::HashWithIndifferentAccess.new(attributes)
108
+ @handle = attributes[:handle].to_s
109
+ @display_name = attributes.fetch(:display_name, attributes[:handle].to_s)
110
+ @supported = attributes.fetch(:supported, false)
111
+ @latest_supported = attributes.fetch(:latest_supported, false)
112
+ @verified = attributes.fetch(:verified, false)
113
+ end
114
+
115
+ def to_s
116
+ handle
117
+ end
118
+
119
+ def latest_supported?
120
+ latest_supported
121
+ end
122
+
123
+ def supported?
124
+ supported
125
+ end
126
+
127
+ def verified?
128
+ verified
129
+ end
130
+
131
+ def <=>(other)
132
+ handle_as_date <=> other.handle_as_date
133
+ end
134
+
135
+ def ==(other)
136
+ other.class == self.class && handle == other.handle
137
+ end
138
+
139
+ def hash
140
+ handle.hash
141
+ end
142
+
143
+ def construct_api_path(path)
144
+ "#{API_PREFIX}#{handle}/#{path}"
145
+ end
146
+
147
+ def construct_graphql_path
148
+ construct_api_path('graphql.json')
149
+ end
150
+
151
+ def name
152
+ warn(
153
+ '[DEPRECATED] ShopifyAPI::ApiVersion#name is deprecated and will be removed in a future version. ' \
154
+ 'Use `handle` instead.'
155
+ )
156
+ handle
157
+ end
158
+
159
+ def stable?
160
+ warn(
161
+ '[DEPRECATED] ShopifyAPI::ApiVersion#stable? is deprecated and will be removed in a future version. ' \
162
+ 'Use `supported?` instead.'
163
+ )
164
+ supported?
165
+ end
166
+
167
+ def unstable?
168
+ handle == UNSTABLE_HANDLE
169
+ end
170
+
171
+ def handle_as_date
172
+ return UNSTABLE_AS_DATE if unstable?
173
+ year, month, day = handle.split('-')
174
+ Time.utc(year, month, day)
175
+ end
176
+
177
+ class NullVersion
178
+ class << self
179
+ def new(*_args)
180
+ raise NoMethodError, "NullVersion is an abstract class and cannot be instantiated."
181
+ end
182
+
183
+ def matches?(version)
184
+ version.nil? || version == self
185
+ end
186
+
187
+ def raise_not_set_error(*_args)
188
+ raise ApiVersionNotSetError, "You must set ShopifyAPI::Base.api_version before making a request."
189
+ end
190
+ alias_method :stable?, :raise_not_set_error
191
+ alias_method :construct_api_path, :raise_not_set_error
192
+ alias_method :construct_graphql_path, :raise_not_set_error
193
+ alias_method :latest_supported?, :raise_not_set_error
194
+ alias_method :supported?, :raise_not_set_error
195
+ alias_method :verified?, :raise_not_set_error
196
+ alias_method :unstable?, :raise_not_set_error
197
+ alias_method :handle, :raise_not_set_error
198
+ alias_method :display_name, :raise_not_set_error
199
+ alias_method :supported, :raise_not_set_error
200
+ alias_method :verified, :raise_not_set_error
201
+ alias_method :latest_supported, :raise_not_set_error
202
+ alias_method :name, :raise_not_set_error
203
+ end
204
+ end
205
+ end
206
+ end
@@ -0,0 +1,36 @@
1
+ # frozen_string_literal: true
2
+ module ShopifyAPI
3
+ class Connection < ActiveResource::Connection
4
+ attr_reader :response
5
+
6
+ module ResponseCapture
7
+ def handle_response(response)
8
+ @response = super(ShopifyAPI::MessageEnricher.new(response))
9
+ end
10
+ end
11
+
12
+ include ResponseCapture
13
+
14
+ module RequestNotification
15
+ def request(method, path, *arguments)
16
+ super.tap do |response|
17
+ notify_about_request(method, path, response, arguments)
18
+ end
19
+ rescue => e
20
+ notify_about_request(method, path, e.response, arguments) if e.respond_to?(:response)
21
+ raise
22
+ end
23
+
24
+ def notify_about_request(method, path, response, arguments)
25
+ ActiveSupport::Notifications.instrument("request.active_resource_detailed") do |payload|
26
+ payload[:method] = method
27
+ payload[:path] = path
28
+ payload[:response] = response
29
+ payload[:data] = arguments
30
+ end
31
+ end
32
+ end
33
+
34
+ include RequestNotification
35
+ end
36
+ end
@@ -0,0 +1,15 @@
1
+ # frozen_string_literal: true
2
+ module ShopifyAPI
3
+ module Countable
4
+ def count(options = {})
5
+ data = get(:count, options)
6
+
7
+ count = case data
8
+ when Hash then data["count"]
9
+ else data
10
+ end
11
+
12
+ Integer(count)
13
+ end
14
+ end
15
+ end
@@ -0,0 +1,31 @@
1
+ # frozen_string_literal: true
2
+ module ShopifyAPI
3
+ module DisablePrefixCheck
4
+ extend ActiveSupport::Concern
5
+
6
+ module ClassMethods
7
+ def check_prefix_options(options)
8
+ end
9
+
10
+ # `flexible = true` is hack to allow multiple things through the same AR class
11
+ def conditional_prefix(resource, flexible = false)
12
+ resource_id = "#{resource}_id".to_sym
13
+ resource_type = flexible ? ":#{resource}" : resource.to_s.pluralize
14
+
15
+ init_prefix_explicit(resource_type, resource_id)
16
+
17
+ define_singleton_method(:resource_prefix) do |options = {}|
18
+ resource_type = options[resource] if flexible
19
+
20
+ options[resource_id].nil? ? '' : "#{resource_type}/#{options[resource_id]}/"
21
+ end
22
+
23
+ define_singleton_method(:instantiate_record) do |record, prefix_options = {}|
24
+ new(record, true).tap do |resource_instance|
25
+ resource_instance.prefix_options = prefix_options unless prefix_options.blank?
26
+ end
27
+ end
28
+ end
29
+ end
30
+ end
31
+ end
@@ -0,0 +1,8 @@
1
+ # frozen_string_literal: true
2
+ module ShopifyAPI
3
+ module Events
4
+ def events
5
+ Event.find(:all, params: { resource: self.class.collection_name, resource_id: id })
6
+ end
7
+ end
8
+ end
@@ -0,0 +1,22 @@
1
+ # frozen_string_literal: true
2
+ require 'graphql/client/http'
3
+
4
+ module ShopifyAPI
5
+ module GraphQL
6
+ class HTTPClient < ::GraphQL::Client::HTTP
7
+ def initialize(api_version)
8
+ @api_version = api_version
9
+ end
10
+
11
+ def headers(_context)
12
+ ShopifyAPI::Base.headers
13
+ end
14
+
15
+ def uri
16
+ ShopifyAPI::Base.site.dup.tap do |uri|
17
+ uri.path = @api_version.construct_graphql_path
18
+ end
19
+ end
20
+ end
21
+ end
22
+ end
@@ -0,0 +1,17 @@
1
+ # frozen_string_literal: true
2
+ require 'rails/railtie'
3
+
4
+ module ShopifyAPI
5
+ module GraphQL
6
+ class Railtie < Rails::Railtie
7
+ initializer 'shopify_api.initialize_graphql_clients' do |app|
8
+ ShopifyAPI::GraphQL.schema_location = app.root.join('db', ShopifyAPI::GraphQL.schema_location)
9
+ ShopifyAPI::GraphQL.initialize_clients
10
+ end
11
+
12
+ rake_tasks do
13
+ load 'shopify_api/graphql/task.rake'
14
+ end
15
+ end
16
+ end
17
+ end
@@ -0,0 +1,100 @@
1
+ # frozen_string_literal: true
2
+ require 'fileutils'
3
+
4
+ namespace :shopify_api do
5
+ namespace :graphql do
6
+ desc 'Dumps a local JSON schema file of the Shopify Admin API'
7
+ task :dump do
8
+ usage = <<~USAGE
9
+
10
+ Usage: rake shopify_api:graphql:dump [<args>]
11
+
12
+ Dumps a local JSON schema file of the Shopify Admin API. The schema is specific to an
13
+ API version and authentication is required (either OAuth or private app).
14
+
15
+ Dump the schema file for the 2020-01 API version using private app authentication:
16
+ $ rake shopify_api:graphql:dump SHOP_URL="https://API_KEY:PASSWORD@SHOP_NAME.myshopify.com" API_VERSION=2020-01
17
+
18
+ Dump the schema file for the unstable API version using an OAuth access token:
19
+ $ rake shopify_api:graphql:dump SHOP_DOMAIN=SHOP_NAME.myshopify.com ACCESS_TOKEN=abc API_VERSION=unstable
20
+
21
+ See https://github.com/Shopify/shopify_api#getting-started for more
22
+ details on getting started with authenticated API calls.
23
+
24
+ Arguments:
25
+ ACCESS_TOKEN OAuth access token (shop specific)
26
+ API_VERSION API version handle [example: 2020-01]
27
+ SHOP_DOMAIN Shop domain (without path) [example: SHOP_NAME.myshopify.com]
28
+ SHOP_URL Shop URL for private apps [example: https://API_KEY:PASSWORD@SHOP_NAME.myshopify.com]
29
+ USAGE
30
+
31
+ access_token = ENV['ACCESS_TOKEN'] || ENV['access_token']
32
+ api_version = ENV['API_VERSION'] || ENV['api_version']
33
+ shop_url = ENV['SHOP_URL'] || ENV['shop_url']
34
+ shop_domain = ENV['SHOP_DOMAIN'] || ENV['shop_domain']
35
+
36
+ unless access_token || api_version || shop_url || shop_domain
37
+ puts usage
38
+ exit(1)
39
+ end
40
+
41
+ unless shop_url || shop_domain
42
+ puts 'Error: either SHOP_DOMAIN or SHOP_URL is required for authentication'
43
+ puts usage
44
+ exit(1)
45
+ end
46
+
47
+ if shop_url && shop_domain
48
+ puts 'Error: SHOP_DOMAIN and SHOP_URL cannot be used together. Use one or the other for authentication.'
49
+ puts usage
50
+ exit(1)
51
+ end
52
+
53
+ if shop_domain && !access_token
54
+ puts 'Error: ACCESS_TOKEN required when SHOP_DOMAIN is used'
55
+ puts usage
56
+ exit(1)
57
+ end
58
+
59
+ unless api_version
60
+ puts 'Error: API_VERSION required. Example: 2020-01'
61
+ puts usage
62
+ exit(1)
63
+ end
64
+
65
+ Rake::Task['environment'].invoke if Rake::Task.task_defined?('environment')
66
+
67
+ ShopifyAPI::ApiVersion.fetch_known_versions
68
+ ShopifyAPI::ApiVersion.version_lookup_mode = :raise_on_unknown
69
+
70
+ shopify_session = ShopifyAPI::Session.new(domain: shop_domain, token: access_token, api_version: api_version)
71
+ ShopifyAPI::Base.activate_session(shopify_session)
72
+
73
+ if shop_url
74
+ ShopifyAPI::Base.site = shop_url
75
+ end
76
+
77
+ puts "Fetching schema for #{ShopifyAPI::Base.api_version.handle} API version..."
78
+
79
+ client = ShopifyAPI::GraphQL::HTTPClient.new(ShopifyAPI::Base.api_version)
80
+ document = GraphQL.parse('{ __schema { queryType { name } } }')
81
+ response = client.execute(document: document).to_h
82
+
83
+ unless response['data'].present?
84
+ puts "Error: failed to query the API."
85
+ puts "Response: #{response}"
86
+ puts 'Ensure your SHOP_DOMAIN or SHOP_URL are valid and you have valid authentication credentials.'
87
+ puts usage
88
+ exit(1)
89
+ end
90
+
91
+ schema_location = ShopifyAPI::GraphQL.schema_location
92
+ FileUtils.mkdir_p(schema_location) unless Dir.exist?(schema_location)
93
+
94
+ schema_file = schema_location.join("#{api_version}.json")
95
+ GraphQL::Client.dump_schema(client, schema_file.to_s)
96
+
97
+ puts "Wrote file #{schema_file}"
98
+ end
99
+ end
100
+ end
@@ -0,0 +1,103 @@
1
+ # frozen_string_literal: true
2
+ require 'graphql/client'
3
+ require 'shopify_api/graphql/http_client'
4
+
5
+ module ShopifyAPI
6
+ module GraphQL
7
+ DEFAULT_SCHEMA_LOCATION_PATH = Pathname('shopify_graphql_schemas')
8
+ DEFAULT_EXECUTION_ADAPTER = HTTPClient
9
+ DEFAULT_GRAPHQL_CLIENT = ::GraphQL::Client
10
+
11
+ InvalidSchema = Class.new(StandardError)
12
+ InvalidClient = Class.new(StandardError)
13
+
14
+ class << self
15
+ delegate :parse, :query, to: :client
16
+
17
+ def client(api_version = ShopifyAPI::Base.api_version.handle)
18
+ initialize_client_cache
19
+ cached_client = @_client_cache[api_version]
20
+
21
+ if cached_client
22
+ cached_client
23
+ else
24
+ schema_file = schema_location.join("#{api_version}.json")
25
+
26
+ if !schema_file.exist?
27
+ raise InvalidClient, <<~MSG
28
+ Client for API version #{api_version} does not exist because no schema file exists at `#{schema_file}`.
29
+
30
+ To dump the schema file, use the `rake shopify_api:graphql:dump` task.
31
+ MSG
32
+ else
33
+ puts(
34
+ '[WARNING] Client was not pre-initialized. Ensure `ShopifyAPI::GraphQL.initialize_clients` ' \
35
+ 'is called during app initialization.'
36
+ )
37
+ initialize_clients
38
+ @_client_cache[api_version]
39
+ end
40
+ end
41
+ end
42
+
43
+ def clear_clients
44
+ @_client_cache = {}
45
+ end
46
+
47
+ def initialize_clients(raise_on_invalid_schema: true)
48
+ initialize_client_cache
49
+
50
+ Dir.glob(schema_location.join("*.json")).each do |schema_file|
51
+ schema_file = Pathname(schema_file)
52
+ matches = schema_file.basename.to_s.match(/^#{ShopifyAPI::ApiVersion::HANDLE_FORMAT}\.json$/)
53
+
54
+ if matches
55
+ api_version = ShopifyAPI::ApiVersion.new(handle: matches[1])
56
+ elsif raise_on_invalid_schema
57
+ raise InvalidSchema,
58
+ "Invalid schema file name `#{schema_file}`. Does not match format of: `<version>.json`."
59
+ else
60
+ next
61
+ end
62
+
63
+ schema = graphql_client.load_schema(schema_file.to_s)
64
+ client = graphql_client.new(schema: schema, execute: execution_adapter.new(api_version)).tap do |c|
65
+ c.allow_dynamic_queries = true
66
+ end
67
+
68
+ @_client_cache[api_version.handle] = client
69
+ end
70
+ end
71
+
72
+ def schema_location
73
+ @schema_location || DEFAULT_SCHEMA_LOCATION_PATH
74
+ end
75
+
76
+ def schema_location=(path)
77
+ @schema_location = Pathname(path)
78
+ end
79
+
80
+ def execution_adapter
81
+ @execution_adapter || DEFAULT_EXECUTION_ADAPTER
82
+ end
83
+
84
+ def execution_adapter=(executor)
85
+ @execution_adapter = executor
86
+ end
87
+
88
+ def graphql_client
89
+ @graphql_client || DEFAULT_GRAPHQL_CLIENT
90
+ end
91
+
92
+ def graphql_client=(client)
93
+ @graphql_client = client
94
+ end
95
+
96
+ private
97
+
98
+ def initialize_client_cache
99
+ @_client_cache ||= {}
100
+ end
101
+ end
102
+ end
103
+ end