lucid_shopify 0.5.3 → 0.7.0

data/lib/lucid_shopify/put_request.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
-require 'lucid_shopify/request'
+require 'lucid_shopify'
 
 module LucidShopify
   class PutRequest < Request
+    #
+    # @private
     #
     # @param credentials [RequestCredentials]
     # @param path [String] the endpoint relative to the base URL

data/lib/lucid_shopify/request.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'dry-initializer'
+require 'lucid_shopify'
 
 module LucidShopify
   #
@@ -29,10 +29,10 @@ module LucidShopify
     private def build_url
       admin_url = "https://#{credentials.myshopify_domain}/admin"
 
-      path = path.sub(/^\//, '')
-      path = path.sub(/\.json$/, '')
+      normalized_path = path.sub(/^\//, '')
+      normalized_path = path.sub(/\.json$/, '')
 
-      admin_url + '/' + path + '.json'
+      admin_url + '/' + normalized_path + '.json'
     end
 
     #
@@ -43,7 +43,7 @@ module LucidShopify
 
       {}.tap do |headers|
         headers['Accept'] = 'application/json'
-        headers['X-Shopify-Access-token'] = access_token if access_token
+        headers['X-Shopify-Access-Token'] = access_token if access_token
       end
     end
   end

data/lib/lucid_shopify/request_credentials.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'dry-initializer'
+require 'lucid_shopify'
 
 module LucidShopify
   class RequestCredentials

data/lib/lucid_shopify/response.rb

@@ -1,14 +1,15 @@
 # frozen_string_literal: true
 
-require 'dry-initializer'
 require 'json'
 
+require 'lucid_shopify'
+
 module LucidShopify
   class Response
     #
     # @abstract
     #
-    class Error < StandardError
+    class Error < Error
       extend Dry::Initializer
 
       # @return [Request]
@@ -62,29 +63,11 @@ module LucidShopify
     end
 
     #
-    # @return [String]
-    #
-    # @see {#assert!}
-    #
-    def data!
-      assert!.data
-    end
-
-    #
-    # @return [Hash] the parsed response body
-    #
-    # @see {#assert!}
-    #
-    def data_hash!
-      assert!.data_hash
-    end
-
+    # @return [self]
     #
     # @raise [ClientError] for status 4xx
     # @raise [ServerError] for status 5xx
     #
-    # @return [self]
-    #
     def assert!
       case status_code
       when 400..499

data/lib/lucid_shopify/send_request.rb

@@ -1,13 +1,12 @@
 # frozen_string_literal: true
 
-require 'dry-initializer'
 require 'http'
 
-require 'lucid_shopify/response'
+require 'lucid_shopify'
 
 module LucidShopify
   class SendRequest
-    class NetworkError < StandardError
+    class NetworkError < Error
       extend Dry::Initializer
 
       # @return [HTTP::Error]
@@ -24,23 +23,28 @@ module LucidShopify
     # @raise [Response::ClientError] for status 4xx
     # @raise [Response::ServerError] for status 5xx
     #
-    def call(request, attempts = default_attempts)
-      req = request
-      res = send(req.http_method, req.url, req.options)
-      res = Response.new(req, res.code, res.headers.to_h, res.to_s)
+    def call(request, attempts: default_attempts)
+      res = send(request)
+      res = Response.new(request, res.code, res.headers.to_h, res.to_s)
 
-      res.data_hash!
-    rescue *http_network_errors => e
+      res.assert!.data_hash
+    rescue HTTP::ConnectionError,
+           HTTP::ResponseError,
+           HTTP::TimeoutError => e
       raise NetworkError.new(e), e.message if attempts.zero?
 
-      call(request, attempts - 1)
+      call(request, attempts: attempts - 1)
     end
 
+    #
+    # @param request [Request]
     #
     # @return [HTTP::Response]
     #
-    private def send(http_method, url, options)
-      HTTP.headers(request.headers).__send__(http_method, url, options)
+    private def send(request)
+      req = request
+
+      HTTP.headers(req.http_headers).__send__(req.http_method, req.url, req.options)
     end
 
     #
@@ -49,16 +53,5 @@ module LucidShopify
     private def default_attempts
       3
     end
-
-    #
-    # @return [Array<Class>]
-    #
-    private def http_network_errors
-      [
-        HTTP::ConnectionError,
-        HTTP::ResponseError,
-        HTTP::TimeoutError,
-      ]
-    end
   end
 end

data/lib/lucid_shopify/send_throttled_request.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require 'lucid_shopify/send_request'
+require 'lucid_shopify'
 
 module LucidShopify
   class SendThrottledRequest < SendRequest
     MINIMUM_INTERVAL = 500 # ms
 
     #
-    # @see {SendRequest#call}
+    # @see SendRequest#call
     #
     private def call(*)
       interval

data/lib/lucid_shopify/version.rb

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

data/lib/lucid_shopify/webhook.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
-require 'dry-initializer'
 require 'json'
 
+require 'lucid_shopify'
+
 module LucidShopify
   class Webhook
     extend Dry::Initializer

data/lib/lucid_shopify.rb

@@ -1,26 +1,34 @@
 # frozen_string_literal: true
 
-# Primarily for Bundler.
+require 'dry/initializer'
 
-require 'lucid_shopify/activate_charge'
-require 'lucid_shopify/charge'
-require 'lucid_shopify/client'
-require 'lucid_shopify/create_charge'
-require 'lucid_shopify/credentials'
-require 'lucid_shopify/delegate_webhooks'
-require 'lucid_shopify/delete_request'
-require 'lucid_shopify/fetch_access_token'
-require 'lucid_shopify/get_request'
-require 'lucid_shopify/post_request'
-require 'lucid_shopify/put_request'
-require 'lucid_shopify/request_credentials'
-require 'lucid_shopify/request'
-require 'lucid_shopify/response'
-require 'lucid_shopify/result'
-require 'lucid_shopify/send_request'
-require 'lucid_shopify/send_throttled_request'
-require 'lucid_shopify/verify_callback'
-require 'lucid_shopify/verify_webhook'
-require 'lucid_shopify/version'
-require 'lucid_shopify/webhook'
-require 'lucid_shopify/webhooks'
+module LucidShopify
+  autoload :ActivateCharge, 'lucid_shopify/activate_charge'
+  autoload :AssertCallback, 'lucid_shopify/assert_callback'
+  autoload :AssertWebhook, 'lucid_shopify/assert_webhook'
+  autoload :Charge, 'lucid_shopify/charge'
+  autoload :Client, 'lucid_shopify/client'
+  autoload :Config, 'lucid_shopify/config'
+  autoload :Container, 'lucid_shopify/container'
+  autoload :CreateAllWebhooks, 'lucid_shopify/create_all_webhooks'
+  autoload :CreateCharge, 'lucid_shopify/create_charge'
+  autoload :CreateWebhook, 'lucid_shopify/create_webhook'
+  autoload :DelegateWebhooks, 'lucid_shopify/delegate_webhooks'
+  autoload :DeleteAllWebhooks, 'lucid_shopify/delete_all_webhooks'
+  autoload :DeleteRequest, 'lucid_shopify/delete_request'
+  autoload :DeleteWebhook, 'lucid_shopify/delete_webhook'
+  autoload :Error, 'lucid_shopify/error'
+  autoload :FetchAccessToken, 'lucid_shopify/fetch_access_token'
+  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 :Request, 'lucid_shopify/request'
+  autoload :Response, 'lucid_shopify/response'
+  autoload :Result, 'lucid_shopify/result'
+  autoload :SendRequest, 'lucid_shopify/send_request'
+  autoload :ThrottledRequest, 'lucid_shopify/send_throttled_request'
+  autoload :VERSION, 'lucid_shopify/version'
+  autoload :Webhook, 'lucid_shopify/webhook'
+  autoload :Webhooks, 'lucid_shopify/webhooks'
+end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: lucid_shopify
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.7.0
 platform: ruby
 authors:
 - Kelsey Judson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-02 00:00:00.000000000 Z
+date: 2018-04-30 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +66,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.52.0
+- !ruby/object:Gem::Dependency
+  name: dry-container
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: dry-initializer
   requirement: !ruby/object:Gem::Requirement
@@ -75,12 +117,20 @@ files:
 - README.md
 - lib/lucid_shopify.rb
 - lib/lucid_shopify/activate_charge.rb
+- lib/lucid_shopify/assert_callback.rb
+- lib/lucid_shopify/assert_webhook.rb
 - lib/lucid_shopify/charge.rb
 - lib/lucid_shopify/client.rb
+- lib/lucid_shopify/config.rb
+- lib/lucid_shopify/container.rb
+- lib/lucid_shopify/create_all_webhooks.rb
 - lib/lucid_shopify/create_charge.rb
-- lib/lucid_shopify/credentials.rb
+- lib/lucid_shopify/create_webhook.rb
 - lib/lucid_shopify/delegate_webhooks.rb
+- lib/lucid_shopify/delete_all_webhooks.rb
 - lib/lucid_shopify/delete_request.rb
+- lib/lucid_shopify/delete_webhook.rb
+- lib/lucid_shopify/error.rb
 - lib/lucid_shopify/fetch_access_token.rb
 - lib/lucid_shopify/get_request.rb
 - lib/lucid_shopify/post_request.rb
@@ -88,14 +138,10 @@ files:
 - lib/lucid_shopify/request.rb
 - lib/lucid_shopify/request_credentials.rb
 - lib/lucid_shopify/response.rb
-- lib/lucid_shopify/result.rb
 - lib/lucid_shopify/send_request.rb
 - lib/lucid_shopify/send_throttled_request.rb
-- lib/lucid_shopify/verify_callback.rb
-- lib/lucid_shopify/verify_webhook.rb
 - lib/lucid_shopify/version.rb
 - lib/lucid_shopify/webhook.rb
-- lib/lucid_shopify/webhooks.rb
 homepage: https://github.com/lucidnz/gem-lucid_shopify
 licenses:
 - ISC

data/lib/lucid_shopify/credentials.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-require 'dry-initializer'
-
-module LucidShopify
-  MissingCredentialsError = Class.new(StandardError)
-
-  class Credentials
-    extend Dry::Initializer
-
-    # @return [String]
-    param :api_key
-    # @return [String]
-    param :shared_secret
-    # @return [String]
-    param :scope
-    # @return [String]
-    param :billing_callback_uri
-    # @return [String]
-    param :webhook_uri
-  end
-end
-
-class << LucidShopify
-  #
-  # Assign default API credentials.
-  #
-  # @param credentials [LucidShopify::Credentials]
-  #
-  attr_writer :credentials
-
-  #
-  # @return [LucidShopify::Credentials]
-  #
-  # @raise [LucidShopify::MissingCredentialsError] if credentials are unset
-  #
-  def credentials
-    raise MissingCredentialsError unless @credentials
-
-    @credentials
-  end
-end

data/lib/lucid_shopify/result.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module LucidShopify
-  class Result
-    #
-    # @param value [Object]
-    # @param error [Object]
-    #
-    def initialize(value, error = nil)
-      @value = value
-      @error = error
-    end
-
-    # @return [Object]
-    attr_reader :value
-    # @return [Object]
-    attr_reader :error
-
-    #
-    # @return [Boolean]
-    #
-    def success?
-      error.nil?
-    end
-
-    #
-    # @return [Boolean]
-    #
-    def failure?
-      !success?
-    end
-  end
-end

data/lib/lucid_shopify/verify_callback.rb

@@ -1,70 +0,0 @@
-# frozen_string_literal: true
-
-require 'openssl'
-
-require 'lucid_shopify/credentials'
-require 'lucid_shopify/result'
-
-module LucidShopify
-  class VerifyCallback
-    #
-    # @param credentials [LucidShopify::Credentials]
-    #
-    def initialize(credentials: LucidShopify.credentials)
-      @credentials = credentials
-    end
-
-    # @return [LucidShopify::Credentials]
-    attr_reader :credentials
-
-    #
-    # Verify that the callback request originated from Shopify.
-    #
-    # @param params_hash [Hash] the request params
-    #
-    # @return [Result]
-    #
-    def call(params_hash)
-      digest = OpenSSL::Digest::SHA256.new
-      digest = OpenSSL::HMAC.hexdigest(digest, credentials.shared_secret, encoded_params(params_hash))
-      result = digest == params_hash[:hmac]
-
-      Result.new(result, result ? nil : 'invalid request')
-    end
-
-    #
-    # @param params_hash [Hash]
-    #
-    # @return [String]
-    #
-    private def encoded_params(params_hash)
-      params_hash.reject do |k, _|
-        k == :hmac
-      end.map do |k, v|
-        encode_key(k) + '=' + encode_value(v)
-      end.join('&')
-    end
-
-    #
-    # @param k [String, Symbol]
-    #
-    # @return [String]
-    #
-    private def encode_key(k)
-      k.to_s.gsub(/./) do |chr|
-        {'%' => '%25', '&' => '%26', '=' => '%3D'}[chr] || chr
-      end
-    end
-
-    #
-    # @param v [String]
-    #
-    # @return [String]
-    #
-    private def encode_value(v)
-      v.gsub(/./) do |chr|
-        {'%' => '%25', '&' => '%26'}[chr] || chr
-      end
-    end
-  end
-end

data/lib/lucid_shopify/verify_webhook.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-require 'base64'
-require 'openssl'
-
-require 'lucid_shopify/credentials'
-require 'lucid_shopify/result'
-
-module LucidShopify
-  class VerifyWebhook
-    Error = Class.new(StandardError)
-
-    #
-    # @param credentials [LucidShopify::Credentials]
-    #
-    def initialize(credentials: LucidShopify.credentials)
-      @credentials = credentials
-    end
-
-    # @return [LucidShopify::Credentials]
-    attr_reader :credentials
-
-    #
-    # Verify that the webhook request originated from Shopify.
-    #
-    # @param data [String] the signed request data
-    # @param hmac [String] the signature
-    #
-    # @return [Result]
-    #
-    def call(data, hmac)
-      digest = OpenSSL::Digest::SHA256.new
-      digest = OpenSSL::HMAC.digest(digest, credentials.shared_secret, data)
-      digest = Base64.encode64(digest).strip
-      result = digest == hmac
-
-      Result.new(result, result ? nil : 'invalid request')
-    end
-  end
-end

data/lib/lucid_shopify/webhooks.rb

@@ -1,82 +0,0 @@
-# frozen_string_literal: true
-
-require 'dry-initializer'
-
-require 'lucid_shopify/client'
-require 'lucid_shopify/credentials'
-
-module LucidShopify
-  class Webhooks
-    extend Dry::Initializer
-
-    # @return [Client]
-    option :client, default: proc { Client.new }
-    # @return [Credentials]
-    option :credentials, default: proc { LucidShopify.credentials }
-
-    #
-    # Delete any existing webhooks, then (re)create all webhooks for the shop.
-    #
-    # @param request_credentials [RequestCredentials]
-    #
-    def create_all(request_credentials)
-      delete_all
-
-      LucidShopify.webhooks.map do |webhook|
-        Thread.new { create(request_credentials, webhook) }
-      end.map(&:value)
-    end
-
-    #
-    # Create a webhook.
-    #
-    # @param request_credentials [RequestCredentials]
-    # @param webhook [Hash]
-    #
-    def create(request_credentials, webhook)
-      data = {}
-      data[:address] = credentials.webhook_uri
-      data[:fields] = webhook[:fields] if webhook[:fields]
-      data[:topic] = webhook[:topic]
-
-      client.post_json(request_credentials, 'webhooks', webhook: data)
-    end
-
-    #
-    # Delete any existing webhooks.
-    #
-    # @param request_credentials [RequestCredentials]
-    #
-    def delete_all(request_credentials)
-      webhooks = client.get('webhooks')['webhooks']
-
-      webhooks.map do |webhook|
-        Thread.new { delete(request_credentials, webhook['id']) }
-      end.map(&:value)
-    end
-
-    #
-    # Delete a webhook.
-    #
-    # @param request_credentials [RequestCredentials]
-    # @param id [Integer]
-    #
-    def delete(request_credentials, id)
-      client.delete(request_credentials, "webhooks/#{id}")
-    end
-  end
-end
-
-class << LucidShopify
-  #
-  # Webhooks created for each shop.
-  #
-  # @return [Array<Hash>]
-  #
-  # @example
-  #   LucidShopify.webhooks << {topic: 'orders/create', fields: %w(id)}
-  #
-  def webhooks
-    @webhooks ||= []
-  end
-end