cardknox 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c53c7db0e62bc7bd4799ff878f81554ed381dda6d9989a7054197d73028de198
+  data.tar.gz: ea882b0a1b4a94dd801d6a755907d4047d9017bbaf8010f0c89373a282d27634
+SHA512:
+  metadata.gz: dbdedf3526d79d36f7c0eea2e6473b6de996e93764bb38654995fb6972e8b2ca3503fc3c69d7e6e26037c861d2cb35d65430ad414037e22ca77f88c6fb04babe
+  data.tar.gz: a53cf4567ee92d3c840bcc7013e02fab89336fd67003c692956ab3957e55b404fe3bb1943bc7812f52d3ac7cd8a90bd5619c6e904dd8c23b10c78352a7dcdf14

data/.env.template

@@ -0,0 +1 @@
+API_KEY=API_KEY

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,22 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+inherit_gem:
+  rubocop-shopify: rubocop.yml
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.0
+
+Gemspec/RequireMFA:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Algonauti
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+# Cardknox
+
+A lightweight Ruby client for interacting with the Cardknox API, built using `faraday`. It provides an easy and minimal setup for handling payments and other operations via Cardknox.
+
+![CI](https://github.com/algonauti/cardknox/actions/workflows/ci.yml/badge.svg)
+
+## Usage
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cardknox'
+```
+
+## Usage
+
+```ruby
+api = Cardknox::API::Client.new('your_api_key') do |config|
+  config.gateway_version = "5.0.0"
+  config.software_name = "CardKnox Ruby client"
+  config.software_version = Cardknox::VERSION
+end
+
+response = api.transaction("cc:Sale", {
+  xCardNum: "4111111111111111",
+  xExp: "1225",
+  xAmount: "999"
+})
+
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/algonauti/cardknox.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: [:spec, :rubocop]

data/lib/cardknox/agent.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Cardknox
+  class Agent
+    def initialize(endpoint)
+      @conn = Faraday.new(endpoint) do |config|
+        config.response(:raise_error)
+        config.request(:json)
+      end
+    end
+
+    def get(path, params = {})
+      parse(@conn.get(path, params))
+    end
+
+    def post(path, body = {})
+      parse(@conn.post(path, body))
+    end
+
+    private
+
+    def parse(response)
+      JSON.parse(response.body, symbolize_names: true).tap do |payload|
+        if payload[:xStatus] != "Approved"
+          raise Error::TransactionFailure.new(payload[:xError], response)
+        end
+      end
+    rescue JSON::ParserError
+      response.body
+    end
+  end
+end

data/lib/cardknox/api.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Cardknox
+  module API
+    class Client
+      attr_reader :agent
+      attr_accessor :config
+
+      def initialize(key)
+        @agent = Agent.new(Cardknox::BASE_URL)
+        @config = Cardknox::Configuration.new.tap do |config|
+          config.api_key = key
+        end
+        yield(config) if block_given?
+      end
+
+      def transaction(command, params = {})
+        @agent.post("/gatewayjson", params.merge({
+          xKey: config.api_key,
+          xVersion: config.gateway_version,
+          xSoftwareName: config.software_name,
+          xSoftwareVersion: config.software_version,
+          xCommand: command,
+        }))
+      end
+
+      def status
+        @agent.get("/status")
+      end
+    end
+  end
+end

data/lib/cardknox/configuration.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Cardknox
+  class Configuration
+    attr_accessor :api_key,
+      :gateway_version,
+      :software_name,
+      :software_version
+  end
+end

data/lib/cardknox/error.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Cardknox
+  class Error < StandardError
+    attr_reader :response
+
+    def initialize(exception = nil, response = nil)
+      @response = response
+
+      super(exception)
+    end
+
+    class TransactionFailure < self
+    end
+  end
+end

data/lib/cardknox/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Cardknox
+  VERSION = "0.1.0"
+end

data/lib/cardknox.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "zeitwerk"
+require_relative "cardknox/version"
+
+module Cardknox
+  BASE_URL = "https://x1.cardknox.com"
+
+  class << self
+    def loader
+      @loader ||= Zeitwerk::Loader.for_gem.tap do |loader|
+        loader.inflector.inflect("api" => "API")
+      end
+    end
+  end
+  loader.setup
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: cardknox
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Algonauti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: Provides a ruby interface to interact with the cardknow API
+email:
+- devel@algonauti.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.template"
+- ".rspec"
+- ".rubocop.yml"
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/cardknox.rb
+- lib/cardknox/agent.rb
+- lib/cardknox/api.rb
+- lib/cardknox/configuration.rb
+- lib/cardknox/error.rb
+- lib/cardknox/version.rb
+homepage: https://github.com/algonauti/cardknow
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key: 
+specification_version: 4
+summary: ruby client for easy integration with cardknow API.
+test_files: []