shift4 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d2e77a2a4de91fb5e3cbbdb0afe4839dfa2ad0c84ef30e55dfe41f7c8a65aca6
+  data.tar.gz: e2f79669a86c7b7a4562543909a134fee9ebb574b8b767ef1fead37c86239300
+SHA512:
+  metadata.gz: 17fdea4dc14049f85644da610b8e0e1e4c1b9e69e374e423502491e6352b345b49ceab4b3f81f5cb449a435ba09383acde6722cd64fea2542b4d26d0b2ae1869
+  data.tar.gz: 669b24220013ca6af821d118235f330feda473257babd1b360ee3867e6021d5bba5baa728770ba422cdeea6b6ae8109aa1cd8c81ccc331967e9eecb1805ddfa8

data/bin/console

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "shift4"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/lib/shift4/blacklist.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Shift4
+  # Blacklist can be used to block unwanted charges.
+  class Blacklist
+    extend TransactionBase
+
+    def self.create(params)
+      communicator.post("#{Configuration.api_url}/blacklist", json: params)
+    end
+
+    def self.retrieve(blacklist_rule_id)
+      communicator.get("#{Configuration.api_url}/blacklist/#{blacklist_rule_id}")
+    end
+
+    def self.delete(blacklist_rule_id)
+      communicator.delete("#{Configuration.api_url}/blacklist/#{blacklist_rule_id}")
+    end
+
+    def self.list(params = nil)
+      communicator.get("#{Configuration.api_url}/blacklist", query: params)
+    end
+  end
+end

data/lib/shift4/cards.rb

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

data/lib/shift4/charges.rb

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

data/lib/shift4/communicator.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'httparty'
+
+module Shift4
+  class Communicator
+    class << self
+      attr_accessor :web_consumer
+    end
+
+    @web_consumer = HTTParty
+
+    def self.get(url, query: nil)
+      response = web_consumer.get(url, request(query: query))
+      handle_response(response)
+      response
+    end
+
+    def self.post(url, json: nil, body: nil)
+      response = web_consumer.post(url, request(json: json, body: body))
+      handle_response(response)
+      response
+    end
+
+    def self.delete(url)
+      response = web_consumer.delete(url, request)
+      handle_response(response)
+      response
+    end
+
+    def self.request(json: nil, query: nil, body: nil)
+      headers = {
+        "User-Agent" => "Shift4-Ruby/#{Shift4::VERSION} (Ruby/#{RUBY_VERSION})",
+        "Accept" => "application/json",
+      }
+      if json
+        raise ArgumentError("Cannot specify both body and json") if body
+
+        body = json.to_json
+        headers["Content-Type"] = "application/json"
+      end
+
+      {
+        body: body,
+        query: query,
+        headers: headers,
+        basic_auth: {
+          username: Configuration.secret_key
+        }
+      }
+    end
+
+    def self.handle_response(response)
+      raise Shift4Exception, response if (400..599).cover?(response.code)
+    end
+
+    private_class_method :request, :handle_response
+  end
+end

data/lib/shift4/configuration.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Shift4
+  class Configuration
+    class << self
+      attr_accessor :secret_key
+      attr_reader :api_url, :uploads_url
+    end
+
+    @api_url = 'https://api.shift4.com'
+    @uploads_url = 'https://uploads.api.shift4.com'
+
+    def self.api_url=(api_url)
+      @api_url = if api_url.nil?
+                   'https://api.shift4.com'
+                 else
+                   api_url.gsub(%r{/$}, "")
+                 end
+    end
+
+    def self.uploads_url=(uploads_url)
+      @uploads_url = if uploads_url.nil?
+                       'https://uploads.api.shift4.com'
+                     else
+                       uploads_url.gsub(%r{/$}, "")
+                     end
+    end
+  end
+end

data/lib/shift4/credits.rb

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

data/lib/shift4/cross_sale_offers.rb

@@ -0,0 +1,27 @@
+# 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

data/lib/shift4/customers.rb

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

data/lib/shift4/disputes.rb

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

data/lib/shift4/events.rb

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

data/lib/shift4/file_uploads.rb

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

data/lib/shift4/fraud_warnings.rb

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

data/lib/shift4/payment_methods.rb

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

data/lib/shift4/plans.rb

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

data/lib/shift4/shift4_pay_exception.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module  Shift4
+  class Shift4Exception < StandardError
+    attr_reader :response
+
+    def initialize(response)
+      super(response)
+      @response = response
+    end
+
+    def [](key)
+      response[key]
+    end
+  end
+end

data/lib/shift4/subscriptions.rb

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

data/lib/shift4/tokens.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Shift4
+  class Tokens
+    extend TransactionBase
+
+    def self.create(params)
+      communicator.post("#{Configuration.api_url}/tokens", json: params)
+    end
+
+    def self.retrieve(token_id)
+      communicator.get("#{Configuration.api_url}/tokens/#{token_id}")
+    end
+  end
+end

data/lib/shift4/transaction_base.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Shift4
+  module TransactionBase
+    def communicator
+      @communicator ||= Communicator
+    end
+
+    def communicator=(value)
+      @communicator = value
+    end
+  end
+end

data/lib/shift4/version.rb

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

data/lib/shift4.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'shift4/transaction_base'
+require 'shift4/version'
+require 'shift4/shift4_pay_exception'
+
+require 'shift4/blacklist'
+require 'shift4/cards'
+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'
+require 'shift4/file_uploads'
+require 'shift4/fraud_warnings'
+require 'shift4/payment_methods'
+require 'shift4/plans'
+require 'shift4/subscriptions'
+require 'shift4/tokens'
+
+#
+# Shift4 start point
+module Shift4
+end

metadata

@@ -0,0 +1,218 @@
+--- !ruby/object:Gem::Specification
+name: shift4
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Shift4
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-11-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: waitutil
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+description: Ruby gem simplifying integration with Shift4 API
+email:
+- devsupport@shift4.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/console
+- lib/shift4.rb
+- lib/shift4/blacklist.rb
+- lib/shift4/cards.rb
+- lib/shift4/charges.rb
+- 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
+- lib/shift4/file_uploads.rb
+- lib/shift4/fraud_warnings.rb
+- lib/shift4/payment_methods.rb
+- lib/shift4/plans.rb
+- lib/shift4/shift4_pay_exception.rb
+- lib/shift4/subscriptions.rb
+- lib/shift4/tokens.rb
+- lib/shift4/transaction_base.rb
+- lib/shift4/version.rb
+homepage: https://shift4.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: Shift4 Ruby Gem
+test_files: []