lucid_shopify 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11642f45e00463fcc89f57bb19d198192870ba8da5d08f4b58c15b6d81b9fc17
-  data.tar.gz: 27f2562f2e91badf805f28f670d43c5420b76b0cb3b68c0ca1982244f4762dce
+  metadata.gz: 653ddf7f8c324f940bf9e2d704910377e34f015eee770b52ce8b0928781dcdd1
+  data.tar.gz: e82a027e61ab3d5af7edcad6457bb5e69db804589bb9dce6dc5f65e09f78d199
 SHA512:
-  metadata.gz: d881b0f7703e965ff3b1a33117ce4f9a847189b0b7f24614565363e3ff183fab8d2b2c91acad11e7b51a7c3fa9b658b0029ad8cceba90d5d7118156b084456a4
-  data.tar.gz: b418d1c1418301ea8142e03c928fb07687df36ff717d3c3e2ab79e7c3df726ffb709a4d9e5b3594be45461818941713d8a372f8f691d6ce9f634ab3fced10f94
+  metadata.gz: 8d91712da6b6790a66736fe38c849e18516d6d2fa04b1ba0f7112a5dcae09f74dcf529a8e6ab2515a89b9beaf5d67cf8eae3e3283ef5840859a0ba7996c8da22
+  data.tar.gz: 47cad3f01c5e7282402b0849abd01a1a5ca7b053990b64d2869b9e800493c73431334d8bc221ca1b8abb94493e5fbda1cee6afcdb05362b23bb4a332eaaa06bc

data/README.md

@@ -28,7 +28,7 @@ argument to any of the classes that make use of it.
 
 Additionally, each API request requires authorization:
 
-    request_credentials = LucidShopify::RequestCredentials.new(
+    credentials = LucidShopify::Credentials.new(
       '...', # myshopify_domain
       '...', # access_token
     )
@@ -68,15 +68,15 @@ to create a worker around something like this:
 
 Create/delete all configured webhooks (see above):
 
-    LucidShopify::CreateAllWebhooks.new.(request_credentials)
-    LucidShopify::DeleteAllWebhooks.new.(request_credentials)
+    LucidShopify::CreateAllWebhooks.new.(credentials)
+    LucidShopify::DeleteAllWebhooks.new.(credentials)
 
 Create/delete webhooks manually:
 
     webhook = {topic: 'orders/create', fields: %w(id tags)}
 
-    LucidShopify::CreateWebhook.new.(request_credentials, webhook)
-    LucidShopify::DeleteWebhook.new.(request_credentials, webhook_id)
+    LucidShopify::CreateWebhook.new.(credentials, webhook)
+    LucidShopify::DeleteWebhook.new.(credentials, webhook_id)
 
 
 ### Verification
@@ -102,7 +102,7 @@ Verify webhook requests with the request data and the HMAC header:
 
     authorize = LucidShopify::Authorize.new
 
-    access_token = authorize.(request_credentials, authorization_code)
+    access_token = authorize.(credentials, authorization_code)
 
 
 ### Billing
@@ -111,7 +111,7 @@ Create a new charge:
 
     create_charge = LucidShopify::CreateCharge.new
 
-    charge = create_charge.(request_credentials, charge) # see LucidShopify::Charge
+    charge = create_charge.(credentials, charge) # see LucidShopify::Charge
 
 Redirect the user to `charge['confirmation_url']`. When the user
 returns (see `config.billing_callback_uri`), activate the accepted
@@ -119,21 +119,21 @@ charge:
 
     activate_charge = LucidShopify::ActivateCharge.new
 
-    activate_charge.(request_credentials, accepted_charge)
+    activate_charge.(credentials, accepted_charge)
 
 
 ### Make API requests
 
     client = LucidShopify::Client.new
 
-    client.get(request_credentials, 'orders', since_id: since_id)['orders']
-    client.post_json(request_credentials, 'orders', new_order)
+    client.get(credentials, 'orders', since_id: since_id)['orders']
+    client.post_json(credentials, 'orders', new_order)
 
 
 ### Make throttled API requests
 
-    client.throttled.get(request_credentials, 'orders')
-    client.throttled.post_json(request_credentials, 'orders', new_order)
+    client.throttled.get(credentials, 'orders')
+    client.throttled.post_json(credentials, 'orders', new_order)
 
 Note that throttling currently uses a naive implementation that is
 only maintained across a single thread.

data/lib/lucid_shopify/activate_charge.rb

@@ -14,13 +14,13 @@ module LucidShopify
     #
     # Activate a recurring application charge.
     #
-    # @param request_credentials [RequestCredentials]
+    # @param credentials [Credentials]
     # @param charge [#to_h] an accepted charge received from Shopify via callback
     #
     # @return [Hash] the active charge
     #
-    def call(request_credentials, charge)
-      data = @client.post_json(request_credentials, "recurring_application_charges/#{charge.to_h['id']}/activate", charge.to_h)
+    def call(credentials, charge)
+      data = @client.post_json(credentials, "recurring_application_charges/#{charge.to_h['id']}/activate", charge.to_h)
 
       data['recurring_application_charge']
     end

data/lib/lucid_shopify/authorize.rb

@@ -24,9 +24,9 @@ module LucidShopify
     # @raise [Error] if the response is invalid
     #
     def call(myshopify_domain, authorization_code)
-      request_credentials = RequestCredentials.new(myshopify_domain)
+      credentials = Credentials.new(myshopify_domain)
 
-      data = @client.post_json(request_credentials, 'oauth/access_token', post_data(authorization_code))
+      data = @client.post_json(credentials, 'oauth/access_token', post_data(authorization_code))
 
       raise Error if data['access_token'].nil?
       raise Error if data['scope'] != LucidShopify.config.scope

data/lib/lucid_shopify/create_all_webhooks.rb

@@ -15,14 +15,14 @@ module LucidShopify
     # Create all webhooks for the shop. Shopify ignores any webhooks which
     # already exist remotely.
     #
-    # @param request_credentials [RequestCredentials]
+    # @param credentials [Credentials]
     # @param webhooks [WebhookList]
     #
     # @return [Array<Hash>] response data
     #
-    def call(request_credentials, webhooks: Container[:webhook_list])
+    def call(credentials, webhooks: Container[:webhook_list])
       webhooks.map do |webhook|
-        Thread.new { @create_webhook.(request_credentials, webhook) }
+        Thread.new { @create_webhook.(credentials, webhook) }
       end.map(&:value)
     end
   end

data/lib/lucid_shopify/create_charge.rb

@@ -14,13 +14,13 @@ module LucidShopify
     #
     # Create a new recurring application charge.
     #
-    # @param request_credentials [RequestCredentials]
+    # @param credentials [Credentials]
     # @param charge [Hash]
     #
     # @return [Hash] the pending charge
     #
-    def call(request_credentials, charge)
-      data = @client.post_json(request_credentials, 'recurring_application_charges', post_data(charge))
+    def call(credentials, charge)
+      data = @client.post_json(credentials, 'recurring_application_charges', post_data(charge))
 
       data['recurring_application_charge']
     end

data/lib/lucid_shopify/create_webhook.rb

@@ -12,15 +12,15 @@ module LucidShopify
     end
 
     #
-    # @param request_credentials [RequestCredentials]
+    # @param credentials [Credentials]
     # @param webhook [Hash]
     #
     # @return [Hash] response data
     #
-    def call(request_credentials, webhook)
+    def call(credentials, webhook)
       data = {**webhook, address: LucidShopify.config.webhook_uri}
 
-      @client.post_json(request_credentials, 'webhooks', webhook: data)
+      @client.post_json(credentials, 'webhooks', webhook: data)
     end
   end
 end

data/lib/lucid_shopify/{request_credentials.rb → credentials.rb}

@@ -3,7 +3,7 @@
 require 'lucid_shopify'
 
 module LucidShopify
-  class RequestCredentials
+  class Credentials
     extend Dry::Initializer
 
     # @return [String]

data/lib/lucid_shopify/delete_all_webhooks.rb

@@ -17,15 +17,15 @@ module LucidShopify
     #
     # Delete any existing webhooks.
     #
-    # @param request_credentials [RequestCredentials]
+    # @param credentials [Credentials]
     #
     # @return [Array<Hash>] response data
     #
-    def call(request_credentials)
+    def call(credentials)
       webhooks = @client.get('webhooks')['webhooks']
 
       webhooks.map do |webhook|
-        Thread.new { @delete_webhook.(request_credentials, webhook['id']) }
+        Thread.new { @delete_webhook.(credentials, webhook['id']) }
       end.map(&:value)
     end
   end

data/lib/lucid_shopify/delete_request.rb

@@ -7,7 +7,7 @@ module LucidShopify
     #
     # @private
     #
-    # @param credentials [RequestCredentials]
+    # @param credentials [Credentials]
     # @param path [String] the endpoint relative to the base URL
     #
     def initialize(credentials, path)

data/lib/lucid_shopify/delete_webhook.rb

@@ -12,13 +12,13 @@ module LucidShopify
     end
 
     #
-    # @param request_credentials [RequestCredentials]
+    # @param credentials [Credentials]
     # @param id [Integer]
     #
     # @return [Hash] response data
     #
-    def call(request_credentials, id)
-      @client.delete(request_credentials, "webhooks/#{id}")
+    def call(credentials, id)
+      @client.delete(credentials, "webhooks/#{id}")
     end
   end
 end

data/lib/lucid_shopify/get_request.rb

@@ -7,7 +7,7 @@ module LucidShopify
     #
     # @private
     #
-    # @param credentials [RequestCredentials]
+    # @param credentials [Credentials]
     # @param path [String] the endpoint relative to the base URL
     # @param params [Hash] the query params
     #

data/lib/lucid_shopify/post_request.rb

@@ -7,7 +7,7 @@ module LucidShopify
     #
     # @private
     #
-    # @param credentials [RequestCredentials]
+    # @param credentials [Credentials]
     # @param path [String] the endpoint relative to the base URL
     # @param json [Hash] the JSON request body
     #

data/lib/lucid_shopify/put_request.rb

@@ -7,7 +7,7 @@ module LucidShopify
     #
     # @private
     #
-    # @param credentials [RequestCredentials]
+    # @param credentials [Credentials]
     # @param path [String] the endpoint relative to the base URL
     # @param json [Hash] the JSON request body
     #

data/lib/lucid_shopify/request.rb

@@ -9,7 +9,7 @@ module LucidShopify
   class Request
     extend Dry::Initializer
 
-    # @return [RequestCredentials]
+    # @return [Credentials]
     param :credentials
     # @return [Symbol]
     param :http_method

data/lib/lucid_shopify/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LucidShopify
-  VERSION = '0.14.0'
+  VERSION = '0.15.0'
 end

data/lib/lucid_shopify.rb

@@ -18,7 +18,7 @@ module LucidShopify
   autoload :GetRequest, 'lucid_shopify/get_request'
   autoload :PostRequest, 'lucid_shopify/post_request'
   autoload :PutRequest, 'lucid_shopify/put_request'
-  autoload :RequestCredentials, 'lucid_shopify/request_credentials'
+  autoload :Credentials, 'lucid_shopify/credentials'
   autoload :Request, 'lucid_shopify/request'
   autoload :Response, 'lucid_shopify/response'
   autoload :Result, 'lucid_shopify/result'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lucid_shopify
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Kelsey Judson
@@ -124,6 +124,7 @@ files:
 - lib/lucid_shopify/create_all_webhooks.rb
 - lib/lucid_shopify/create_charge.rb
 - lib/lucid_shopify/create_webhook.rb
+- lib/lucid_shopify/credentials.rb
 - lib/lucid_shopify/delete_all_webhooks.rb
 - lib/lucid_shopify/delete_request.rb
 - lib/lucid_shopify/delete_webhook.rb
@@ -132,7 +133,6 @@ files:
 - lib/lucid_shopify/post_request.rb
 - lib/lucid_shopify/put_request.rb
 - lib/lucid_shopify/request.rb
-- lib/lucid_shopify/request_credentials.rb
 - lib/lucid_shopify/response.rb
 - lib/lucid_shopify/send_request.rb
 - lib/lucid_shopify/send_throttled_request.rb