shift4 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2e77a2a4de91fb5e3cbbdb0afe4839dfa2ad0c84ef30e55dfe41f7c8a65aca6
-  data.tar.gz: e2f79669a86c7b7a4562543909a134fee9ebb574b8b767ef1fead37c86239300
+  metadata.gz: '07539d434b346dfb29dac676752d4092b16d0eb8505256892faf077305a80db3'
+  data.tar.gz: 633888e89d127192b15f2d68708d914d34a4bb090e8e1f2c55dc39d003fbaee9
 SHA512:
-  metadata.gz: 17fdea4dc14049f85644da610b8e0e1e4c1b9e69e374e423502491e6352b345b49ceab4b3f81f5cb449a435ba09383acde6722cd64fea2542b4d26d0b2ae1869
-  data.tar.gz: 669b24220013ca6af821d118235f330feda473257babd1b360ee3867e6021d5bba5baa728770ba422cdeea6b6ae8109aa1cd8c81ccc331967e9eecb1805ddfa8
+  metadata.gz: 2a3f1da475ce49f70a83ac114efa899d3c06445c3f5305aec46b37f3f3729a02a41f34464d3669ca1f09a110e771cbfb920eed6b39bced3b3dc7092d245ae31b
+  data.tar.gz: e353e59012771baa7173df0e62ca1cc9d57a9d0aa076fbf98e0209749dae0203414bde1f6896c3612ce9f6b8d769e29552313f70b3fa4235fa9cd9f07f6500d2

data/lib/shift4/blacklist.rb

@@ -5,20 +5,20 @@ module Shift4
   class Blacklist
     extend TransactionBase
 
-    def self.create(params)
-      communicator.post("#{Configuration.api_url}/blacklist", json: params)
+    def self.create(params, config = Configuration)
+      communicator.post("#{config.api_url}/blacklist", json: params, config: config)
     end
 
-    def self.retrieve(blacklist_rule_id)
-      communicator.get("#{Configuration.api_url}/blacklist/#{blacklist_rule_id}")
+    def self.retrieve(blacklist_rule_id, config = Configuration)
+      communicator.get("#{config.api_url}/blacklist/#{blacklist_rule_id}", config: config)
     end
 
-    def self.delete(blacklist_rule_id)
-      communicator.delete("#{Configuration.api_url}/blacklist/#{blacklist_rule_id}")
+    def self.delete(blacklist_rule_id, config = Configuration)
+      communicator.delete("#{config.api_url}/blacklist/#{blacklist_rule_id}", config: config)
     end
 
-    def self.list(params = nil)
-      communicator.get("#{Configuration.api_url}/blacklist", query: params)
+    def self.list(params = nil, config = Configuration)
+      communicator.get("#{config.api_url}/blacklist", query: params, config: config)
     end
   end
 end

data/lib/shift4/cards.rb

@@ -4,24 +4,24 @@ module Shift4
   class Cards
     extend TransactionBase
 
-    def self.create(customer_id, params)
-      communicator.post("#{Configuration.api_url}/customers/#{customer_id}/cards", json: params)
+    def self.create(customer_id, params, config = Configuration)
+      communicator.post("#{config.api_url}/customers/#{customer_id}/cards", json: params, config: config)
     end
 
-    def self.retrieve(customer_id, card_id)
-      communicator.get("#{Configuration.api_url}/customers/#{customer_id}/cards/#{card_id}")
+    def self.retrieve(customer_id, card_id, config = Configuration)
+      communicator.get("#{config.api_url}/customers/#{customer_id}/cards/#{card_id}", config: config)
     end
 
-    def self.update(customer_id, card_id, params)
-      communicator.post("#{Configuration.api_url}/customers/#{customer_id}/cards/#{card_id}", json: params)
+    def self.update(customer_id, card_id, params, config = Configuration)
+      communicator.post("#{config.api_url}/customers/#{customer_id}/cards/#{card_id}", json: params, config: config)
     end
 
-    def self.delete(customer_id, card_id)
-      communicator.delete("#{Configuration.api_url}/customers/#{customer_id}/cards/#{card_id}")
+    def self.delete(customer_id, card_id, config = Configuration)
+      communicator.delete("#{config.api_url}/customers/#{customer_id}/cards/#{card_id}", config: config)
     end
 
-    def self.list(customer_id, params = nil)
-      communicator.get("#{Configuration.api_url}/customers/#{customer_id}/cards", query: params)
+    def self.list(customer_id, params = nil, config = Configuration)
+      communicator.get("#{config.api_url}/customers/#{customer_id}/cards", query: params, config: config)
     end
   end
 end

data/lib/shift4/charges.rb

@@ -4,28 +4,28 @@ module Shift4
   class Charges
     extend TransactionBase
 
-    def self.create(params)
-      communicator.post("#{Configuration.api_url}/charges", json: params)
+    def self.create(params, config = Configuration)
+      communicator.post("#{config.api_url}/charges", json: params, config: config)
     end
 
-    def self.retrieve(charge_id)
-      communicator.get("#{Configuration.api_url}/charges/#{charge_id}")
+    def self.retrieve(charge_id, config = Configuration)
+      communicator.get("#{config.api_url}/charges/#{charge_id}", config: config)
     end
 
-    def self.update(charge_id, params)
-      communicator.post("#{Configuration.api_url}/charges/#{charge_id}", json: params)
+    def self.update(charge_id, params, config = Configuration)
+      communicator.post("#{config.api_url}/charges/#{charge_id}", json: params, config: config)
     end
 
-    def self.list(params = nil)
-      communicator.get("#{Configuration.api_url}/charges", query: params)
+    def self.list(params = nil, config = Configuration)
+      communicator.get("#{config.api_url}/charges", query: params, config: config)
     end
 
-    def self.capture(charge_id)
-      communicator.post("#{Configuration.api_url}/charges/#{charge_id}/capture")
+    def self.capture(charge_id, config = Configuration)
+      communicator.post("#{config.api_url}/charges/#{charge_id}/capture", config: config)
     end
 
-    def self.refund(charge_id, params = nil)
-      communicator.post("#{Configuration.api_url}/charges/#{charge_id}/refund", json: params)
+    def self.refund(charge_id, params = nil, config = Configuration)
+      communicator.post("#{config.api_url}/charges/#{charge_id}/refund", json: params, config: config)
     end
   end
 end

data/lib/shift4/communicator.rb

@@ -10,29 +10,31 @@ module Shift4
 
     @web_consumer = HTTParty
 
-    def self.get(url, query: nil)
-      response = web_consumer.get(url, request(query: query))
+    def self.get(url, query: nil, config: Configuration)
+      response = web_consumer.get(url, request(query: query, config: config))
       handle_response(response)
       response
     end
 
-    def self.post(url, json: nil, body: nil)
-      response = web_consumer.post(url, request(json: json, body: body))
+    def self.post(url, json: nil, body: nil, config: Configuration)
+      response = web_consumer.post(url, request(json: json, body: body, config: config))
       handle_response(response)
       response
     end
 
-    def self.delete(url)
-      response = web_consumer.delete(url, request)
+    def self.delete(url, config: Configuration)
+      response = web_consumer.delete(url, request(config: config))
       handle_response(response)
       response
     end
 
-    def self.request(json: nil, query: nil, body: nil)
+    def self.request(json: nil, query: nil, body: nil, config: Configuration)
       headers = {
         "User-Agent" => "Shift4-Ruby/#{Shift4::VERSION} (Ruby/#{RUBY_VERSION})",
         "Accept" => "application/json",
       }
+      headers["Shift4-Merchant"] = config.merchant unless config.merchant.nil?
+
       if json
         raise ArgumentError("Cannot specify both body and json") if body
 
@@ -45,7 +47,7 @@ module Shift4
         query: query,
         headers: headers,
         basic_auth: {
-          username: Configuration.secret_key
+          username: config.secret_key
         }
       }
     end

data/lib/shift4/configuration.rb

@@ -3,27 +3,42 @@
 module Shift4
   class Configuration
     class << self
-      attr_accessor :secret_key
+      attr_accessor :secret_key, :merchant
       attr_reader :api_url, :uploads_url
+
+      @api_url = 'https://api.shift4.com'
+      @uploads_url = 'https://uploads.api.shift4.com'
+
+      def api_url=(api_url)
+        @api_url = api_url.nil? ? 'https://api.shift4.com' : api_url.gsub(%r{/$}, "")
+      end
+
+      def uploads_url=(uploads_url)
+        @uploads_url = uploads_url.nil? ? 'https://uploads.api.shift4.com' : uploads_url.gsub(%r{/$}, "")
+      end
     end
 
-    @api_url = 'https://api.shift4.com'
-    @uploads_url = 'https://uploads.api.shift4.com'
+    attr_accessor :secret_key, :merchant
+    attr_reader :api_url, :uploads_url
+
+    def initialize(
+      secret_key:,
+      merchant: nil,
+      api_url: 'https://api.shift4.com',
+      uploads_url: 'https://uploads.api.shift4.com'
+    )
+      self.api_url = api_url
+      self.uploads_url = uploads_url
+      self.secret_key = secret_key
+      self.merchant = merchant
+    end
 
-    def self.api_url=(api_url)
-      @api_url = if api_url.nil?
-                   'https://api.shift4.com'
-                 else
-                   api_url.gsub(%r{/$}, "")
-                 end
+    def api_url=(api_url)
+      @api_url = api_url.nil? ? 'https://api.shift4.com' : api_url.gsub(%r{/$}, "")
     end
 
-    def self.uploads_url=(uploads_url)
-      @uploads_url = if uploads_url.nil?
-                       'https://uploads.api.shift4.com'
-                     else
-                       uploads_url.gsub(%r{/$}, "")
-                     end
+    def uploads_url=(uploads_url)
+      @uploads_url = uploads_url.nil? ? 'https://uploads.api.shift4.com' : uploads_url.gsub(%r{/$}, "")
     end
   end
 end

data/lib/shift4/credits.rb

@@ -4,20 +4,20 @@ module Shift4
   class Credits
     extend TransactionBase
 
-    def self.create(params)
-      communicator.post("#{Configuration.api_url}/credits", json: params)
+    def self.create(params, config = Configuration)
+      communicator.post("#{config.api_url}/credits", json: params, config: config)
     end
 
-    def self.retrieve(credit_id)
-      communicator.get("#{Configuration.api_url}/credits/#{credit_id}")
+    def self.retrieve(credit_id, config = Configuration)
+      communicator.get("#{config.api_url}/credits/#{credit_id}", config: config)
     end
 
-    def self.update(credit_id, params)
-      communicator.post("#{Configuration.api_url}/credits/#{credit_id}", json: params)
+    def self.update(credit_id, params, config = Configuration)
+      communicator.post("#{config.api_url}/credits/#{credit_id}", json: params, config: config)
     end
 
-    def self.list(params = nil)
-      communicator.get("#{Configuration.api_url}/credits", query: params)
+    def self.list(params = nil, config = Configuration)
+      communicator.get("#{config.api_url}/credits", query: params, config: config)
     end
   end
 end

data/lib/shift4/customers.rb

@@ -4,24 +4,24 @@ module Shift4
   class Customers
     extend TransactionBase
 
-    def self.create(params)
-      communicator.post("#{Configuration.api_url}/customers", json: params)
+    def self.create(params, config = Configuration)
+      communicator.post("#{config.api_url}/customers", json: params, config: config)
     end
 
-    def self.retrieve(customer_id)
-      communicator.get("#{Configuration.api_url}/customers/#{customer_id}")
+    def self.retrieve(customer_id, config = Configuration)
+      communicator.get("#{config.api_url}/customers/#{customer_id}", config: config)
     end
 
-    def self.update(customer_id, params)
-      communicator.post("#{Configuration.api_url}/customers/#{customer_id}", json: params)
+    def self.update(customer_id, params, config = Configuration)
+      communicator.post("#{config.api_url}/customers/#{customer_id}", json: params, config: config)
     end
 
-    def self.delete(customer_id)
-      communicator.delete("#{Configuration.api_url}/customers/#{customer_id}")
+    def self.delete(customer_id, config = Configuration)
+      communicator.delete("#{config.api_url}/customers/#{customer_id}", config: config)
     end
 
-    def self.list(params = nil)
-      communicator.get("#{Configuration.api_url}/customers", query: params)
+    def self.list(params = nil, config = Configuration)
+      communicator.get("#{config.api_url}/customers", query: params, config: config)
     end
   end
 end

data/lib/shift4/disputes.rb

@@ -4,20 +4,20 @@ module Shift4
   class Disputes
     extend TransactionBase
 
-    def self.retrieve(dispute_id)
-      communicator.get("#{Configuration.api_url}/disputes/#{dispute_id}")
+    def self.retrieve(dispute_id, config = Configuration)
+      communicator.get("#{config.api_url}/disputes/#{dispute_id}", config: config)
     end
 
-    def self.update(dispute_id, params)
-      communicator.post("#{Configuration.api_url}/disputes/#{dispute_id}", json: params)
+    def self.update(dispute_id, params, config = Configuration)
+      communicator.post("#{config.api_url}/disputes/#{dispute_id}", json: params, config: config)
     end
 
-    def self.close(dispute_id)
-      communicator.post("#{Configuration.api_url}/disputes/#{dispute_id}/close")
+    def self.close(dispute_id, config = Configuration)
+      communicator.post("#{config.api_url}/disputes/#{dispute_id}/close", config: config)
     end
 
-    def self.list(params = nil)
-      communicator.get("#{Configuration.api_url}/disputes", query: params)
+    def self.list(params = nil, config = Configuration)
+      communicator.get("#{config.api_url}/disputes", query: params, config: config)
     end
   end
 end

data/lib/shift4/events.rb

@@ -4,12 +4,12 @@ module Shift4
   class Events
     extend TransactionBase
 
-    def self.retrieve(event_id)
-      communicator.get("#{Configuration.api_url}/events/#{event_id}")
+    def self.retrieve(event_id, config = Configuration)
+      communicator.get("#{config.api_url}/events/#{event_id}", config: config)
     end
 
-    def self.list(params = nil)
-      communicator.get("#{Configuration.api_url}/events", query: params)
+    def self.list(params = nil, config = Configuration)
+      communicator.get("#{config.api_url}/events", query: params, config: config)
     end
   end
 end

data/lib/shift4/file_uploads.rb

@@ -4,17 +4,17 @@ module Shift4
   class FileUploads
     extend TransactionBase
 
-    def self.upload(file, params)
+    def self.upload(file, params, config = Configuration)
       body = { file: file }.merge(params)
-      communicator.post("#{Configuration.uploads_url}/files", body: body)
+      communicator.post("#{config.uploads_url}/files", body: body, config: config)
     end
 
-    def self.list(params = nil)
-      communicator.get("#{Configuration.uploads_url}/files", query: params)
+    def self.list(params = nil, config = Configuration)
+      communicator.get("#{config.uploads_url}/files", query: params, config: config)
     end
 
-    def self.retrieve(file_upload_id)
-      communicator.get("#{Configuration.uploads_url}/files/#{file_upload_id}")
+    def self.retrieve(file_upload_id, config = Configuration)
+      communicator.get("#{config.uploads_url}/files/#{file_upload_id}", config: config)
     end
   end
 end

data/lib/shift4/fraud_warnings.rb

@@ -4,12 +4,12 @@ module Shift4
   class FraudWarnings
     extend TransactionBase
 
-    def self.retrieve(fraud_warning_id)
-      communicator.get("#{Configuration.api_url}/fraud-warnings/#{fraud_warning_id}")
+    def self.retrieve(fraud_warning_id, config = Configuration)
+      communicator.get("#{config.api_url}/fraud-warnings/#{fraud_warning_id}", config: config)
     end
 
-    def self.list(params = nil)
-      communicator.get("#{Configuration.api_url}/fraud-warnings", query: params)
+    def self.list(params = nil, config = Configuration)
+      communicator.get("#{config.api_url}/fraud-warnings", query: params, config: config)
     end
   end
 end

data/lib/shift4/payment_methods.rb

@@ -4,20 +4,20 @@ module Shift4
   class PaymentMethods
     extend TransactionBase
 
-    def self.create(params)
-      communicator.post("#{Configuration.api_url}/payment-methods", json: params)
+    def self.create(params, config = Configuration)
+      communicator.post("#{config.api_url}/payment-methods", json: params, config: config)
     end
 
-    def self.retrieve(plan_id)
-      communicator.get("#{Configuration.api_url}/payment-methods/#{plan_id}")
+    def self.retrieve(plan_id, config = Configuration)
+      communicator.get("#{config.api_url}/payment-methods/#{plan_id}", config: config)
     end
 
-    def self.delete(plan_id)
-      communicator.delete("#{Configuration.api_url}/payment-methods/#{plan_id}")
+    def self.delete(plan_id, config = Configuration)
+      communicator.delete("#{config.api_url}/payment-methods/#{plan_id}", config: config)
     end
 
-    def self.list(params = nil)
-      communicator.get("#{Configuration.api_url}/payment-methods", query: params)
+    def self.list(params = nil, config = Configuration)
+      communicator.get("#{config.api_url}/payment-methods", query: params, config: config)
     end
   end
 end

data/lib/shift4/plans.rb

@@ -4,24 +4,24 @@ module Shift4
   class Plans
     extend TransactionBase
 
-    def self.create(params)
-      communicator.post("#{Configuration.api_url}/plans", json: params)
+    def self.create(params, config = Configuration)
+      communicator.post("#{config.api_url}/plans", json: params, config: config)
     end
 
-    def self.retrieve(plan_id)
-      communicator.get("#{Configuration.api_url}/plans/#{plan_id}")
+    def self.retrieve(plan_id, config = Configuration)
+      communicator.get("#{config.api_url}/plans/#{plan_id}", config: config)
     end
 
-    def self.update(plan_id, params)
-      communicator.post("#{Configuration.api_url}/plans/#{plan_id}", json: params)
+    def self.update(plan_id, params, config = Configuration)
+      communicator.post("#{config.api_url}/plans/#{plan_id}", json: params, config: config)
     end
 
-    def self.delete(plan_id)
-      communicator.delete("#{Configuration.api_url}/plans/#{plan_id}")
+    def self.delete(plan_id, config = Configuration)
+      communicator.delete("#{config.api_url}/plans/#{plan_id}", config: config)
     end
 
-    def self.list(params = nil)
-      communicator.get("#{Configuration.api_url}/plans", query: params)
+    def self.list(params = nil, config = Configuration)
+      communicator.get("#{config.api_url}/plans", query: params, config: config)
     end
   end
 end

data/lib/shift4/subscriptions.rb

@@ -4,24 +4,24 @@ module Shift4
   class Subscriptions
     extend TransactionBase
 
-    def self.create(params)
-      communicator.post("#{Configuration.api_url}/subscriptions", json: params)
+    def self.create(params, config = Configuration)
+      communicator.post("#{config.api_url}/subscriptions", json: params, config: config)
     end
 
-    def self.retrieve(subscription_id)
-      communicator.get("#{Configuration.api_url}/subscriptions/#{subscription_id}")
+    def self.retrieve(subscription_id, config = Configuration)
+      communicator.get("#{config.api_url}/subscriptions/#{subscription_id}", config: config)
     end
 
-    def self.update(subscription_id, params)
-      communicator.post("#{Configuration.api_url}/subscriptions/#{subscription_id}", json: params)
+    def self.update(subscription_id, params, config = Configuration)
+      communicator.post("#{config.api_url}/subscriptions/#{subscription_id}", json: params, config: config)
     end
 
-    def self.cancel(subscription_id)
-      communicator.delete("#{Configuration.api_url}/subscriptions/#{subscription_id}")
+    def self.cancel(subscription_id, config = Configuration)
+      communicator.delete("#{config.api_url}/subscriptions/#{subscription_id}", config: config)
     end
 
-    def self.list(params = nil)
-      communicator.get("#{Configuration.api_url}/subscriptions", query: params)
+    def self.list(params = nil, config = Configuration)
+      communicator.get("#{config.api_url}/subscriptions", query: params, config: config)
     end
   end
 end

data/lib/shift4/tokens.rb

@@ -4,12 +4,12 @@ module Shift4
   class Tokens
     extend TransactionBase
 
-    def self.create(params)
-      communicator.post("#{Configuration.api_url}/tokens", json: params)
+    def self.create(params, config = Configuration)
+      communicator.post("#{config.api_url}/tokens", json: params, config: config)
     end
 
-    def self.retrieve(token_id)
-      communicator.get("#{Configuration.api_url}/tokens/#{token_id}")
+    def self.retrieve(token_id, config = Configuration)
+      communicator.get("#{config.api_url}/tokens/#{token_id}", config: config)
     end
   end
 end

data/lib/shift4/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Shift4
-  VERSION = '1.0.0'
+  VERSION = '2.0.0'
 end

data/lib/shift4.rb

@@ -10,7 +10,6 @@ require 'shift4/charges'
 require 'shift4/communicator'
 require 'shift4/configuration'
 require 'shift4/credits'
-require 'shift4/cross_sale_offers'
 require 'shift4/customers'
 require 'shift4/disputes'
 require 'shift4/events'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shift4
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Shift4
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-11-08 00:00:00.000000000 Z
+date: 2023-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -179,7 +179,6 @@ files:
 - lib/shift4/communicator.rb
 - lib/shift4/configuration.rb
 - lib/shift4/credits.rb
-- lib/shift4/cross_sale_offers.rb
 - lib/shift4/customers.rb
 - lib/shift4/disputes.rb
 - lib/shift4/events.rb
@@ -211,7 +210,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: Shift4 Ruby Gem

data/lib/shift4/cross_sale_offers.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module Shift4
-  class CrossSaleOffers
-    extend TransactionBase
-
-    def self.create(params)
-      communicator.post("#{Configuration.api_url}/cross-sale-offers", json: params)
-    end
-
-    def self.retrieve(cross_sale_offer_id)
-      communicator.get("#{Configuration.api_url}/cross-sale-offers/#{cross_sale_offer_id}")
-    end
-
-    def self.update(cross_sale_offer_id, params)
-      communicator.post("#{Configuration.api_url}/cross-sale-offers/#{cross_sale_offer_id}", json: params)
-    end
-
-    def self.delete(cross_sale_offer_id)
-      communicator.delete("#{Configuration.api_url}/cross-sale-offers/#{cross_sale_offer_id}")
-    end
-
-    def self.list(params = nil)
-      communicator.get("#{Configuration.api_url}/cross-sale-offers", query: params)
-    end
-  end
-end