kobana 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 334079d4826a8bdd4f675cb5ffe61441d2e96ff16c7843ba29297f9f10516014
+  data.tar.gz: b38d41b3fa4af6b6db02170c41b79ad5cc0ae5f6163ca10b4f09db6bcd896933
+SHA512:
+  metadata.gz: e4f171a71676fa12cfc86cf4d7d1215465e53ecedabe3367462e147fd548469339e2f333252acd7737f1c7b6e27482a6a29eaac4e0b0d240e2e1c13af46bd4b0
+  data.tar.gz: 867c12e536ce5766ebac00f7788b802b19d4f6276a18f50425ecfa60b1fb64d7014a4a70385bcd6479b30515c1ee255721da1e24d9d0135455b43c699a317067

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## [Unreleased]
+
+- Add debug option
+
+## [0.1.0] - 2023-10-27
+
+- Initial release

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Kobana
+
+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,131 @@
+
+
+## KobanaRubyClient - Ruby Client for Kobana Services
+
+This Ruby gem provides a convenient method to interact with the Kobana APP, simplifying operations with charges and bank billets.
+
+This is BETA and can change anytimes.
+Use with caution.
+
+### Prerequisites
+
+- Ruby version >= 3.2
+- Access to the Kobana API and a valid API key
+
+### Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kobana_ruby_client'
+```
+
+Then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install kobana_ruby_client
+```
+
+### Configuration
+
+Configure your API key by creating an initializer in your Rails project:
+
+`config/initializers/kobana_ruby_client.rb`
+
+```ruby
+KobanaRubyClient.api_key = 'YOUR_API_KEY_HERE'
+```
+
+Replace `'YOUR_API_KEY_HERE'` with your actual API key.
+
+### Usage
+
+To use this gem:
+
+#### **Configuration**
+
+```ruby
+KobanaRubyClient.configure do |config|
+  config.api_token = 'YOUR_API_KEY'
+  config.environment = :sandbox # you can specify the environment as :development, :sandbox, or :production
+  config.api_version = :v1 #or :v2
+end
+```
+
+#### **Charges**
+
+##### Creating a Charge
+
+```ruby
+charge_data = {
+  'amount' => 100.50,
+  'payer' => {
+    'document_number' => '1234567890',
+    'name' => 'John Doe'
+  },
+  'pix_account_id' => 1,
+  'expire_at' => '2023-12-31',
+  'message' => 'Thanks for your purchase!',
+  'additional_info' => {
+    'Chave' => 'Value'
+  },
+  'custom_data' => '{"order_id": "12345"}'
+}
+
+charge = KobanaRubyClient::Resources::Charge::Pix.new
+result = charge.create(charge_data)
+puts result
+```
+
+##### Fetching a Charge
+
+```ruby
+charge_id = 1  # Replace with your charge ID
+charge = KobanaRubyClient::Resources::Charge::Pix.new
+result = charge.find(charge_id)
+puts result
+```
+
+##### Listing All Charges
+
+```ruby
+charge = KobanaRubyClient::Resources::Charge::Pix.new
+params = { status: ["opened", "overdue"], page: 2 }
+results = charge.index(params)
+puts result
+```
+
+#### **Bank Billets**
+
+##### Creating a Bank Billet
+
+```ruby
+bank_billet_data = { ... }
+
+bank_billet = KobanaRubyClient::Resources::BankBillet::BankBillet.new
+result = bank_billet.create(bank_billet_data)
+puts result
+```
+
+##### Fetching a Bank Billet
+
+```ruby
+bank_billet_id = 1  # Replace with your charge ID
+bank_billet = KobanaRubyClient::Resources::BankBillet::BankBillet.new
+result = bank_billet.find(bank_billet_id)
+puts result
+```
+
+##### Listing All Bank Billets
+
+```ruby
+bank_billet = KobanaRubyClient::Resources::BankBillet::BankBillet.new
+result = bank_billet.index
+puts result
+```

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: %i[spec rubocop]

data/lib/kobana_ruby_client/base.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "json"
+
+module KobanaRubyClient
+  class Base
+    attr_reader :base_url, :custom_headers
+
+    BASE_URI = {
+      v2: {
+        sandbox: "https://api-sandbox.kobana.com.br/v2",
+        production: "https://api.kobana.com.br/v2",
+        development: "http://localhost:5000/api/v2"
+      },
+      v1: {
+        sandbox: "https://api-sandbox.kobana.com.br/v1",
+        production: "https://api.kobana.com.br/v1",
+        development: "http://localhost:5000/api/v1"
+      }
+    }.freeze
+
+    def initialize
+      config = KobanaRubyClient.configuration
+
+      @api_key = config.api_token
+      @base_url = BASE_URI[config.api_version][config.environment]
+      @custom_headers = config.custom_headers
+      @debug = config.debug
+    end
+
+    private
+
+    def default_headers
+      {
+        "Authorization" => "Bearer #{@api_key}",
+        "Content-Type" => "application/json"
+      }
+    end
+
+    def connection
+      headers = default_headers.merge(@custom_headers)
+      Faraday.new(url: @base_url) do |faraday|
+        faraday.request :url_encoded
+        faraday.adapter Faraday.default_adapter
+        faraday.headers = headers
+        faraday.response :logger if @debug
+      end
+    end
+
+    def parse_response(response)
+      body_parsed = JSON.parse(response.body, symbolize_names: true)
+
+      if body_parsed.is_a?(Array) || !body_parsed.key?(:data)
+        { status: response.status, data: body_parsed }
+      else
+        body_parsed
+      end
+    end
+  end
+end

data/lib/kobana_ruby_client/configuration.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module KobanaRubyClient
+  class Configuration
+    attr_accessor :api_token, :environment, :custom_headers, :api_version, :debug
+
+    def initialize
+      @custom_headers = {}
+      @environment = :development
+    end
+  end
+end

data/lib/kobana_ruby_client/resources/charge/bank_billet.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module KobanaRubyClient
+  module Resources
+    module Charge
+      class BankBillet < Base
+        include ResourceOperations
+
+        @resource_endpoint = "bank_billets"
+
+        class << self
+          attr_reader :resource_endpoint
+        end
+
+        def cancel(resource_id)
+          url = "#{base_url}/#{endpoint}/#{resource_id}/cancel"
+          response = connection.put(url)
+          { status: response.status, data: {} }
+        end
+      end
+    end
+  end
+end

data/lib/kobana_ruby_client/resources/charge/pix.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module KobanaRubyClient
+  module Resources
+    module Charge
+      class Pix < Base
+        include ResourceOperations
+
+        @resource_endpoint = "charge/pix"
+
+        class << self
+          attr_reader :resource_endpoint
+        end
+      end
+    end
+  end
+end

data/lib/kobana_ruby_client/resources/resource_operations.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module KobanaRubyClient
+  module Resources
+    module ResourceOperations
+      def index(params = {})
+        url = "#{base_url}/#{endpoint}"
+        response = connection.get(url, params)
+        parse_response(response)
+      end
+
+      def create(data)
+        url = "#{base_url}/#{endpoint}"
+        response = connection.post(url, data.to_json)
+        parse_response(response)
+      end
+
+      def find(resource_id)
+        url = "#{base_url}/#{endpoint}/#{resource_id}"
+        response = connection.get(url)
+        parse_response(response)
+      end
+
+      private
+
+      def endpoint
+        self.class.resource_endpoint
+      end
+    end
+  end
+end

data/lib/kobana_ruby_client/version.rb

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

data/lib/kobana_ruby_client.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "json"
+require "kobana_ruby_client/configuration"
+
+module KobanaRubyClient
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration) if block_given?
+    end
+  end
+
+  autoload :Base, "kobana_ruby_client/base"
+  autoload :Version, "kobana_ruby_client/version"
+
+  module Resources
+    autoload :ResourceOperations, "kobana_ruby_client/resources/resource_operations"
+    module Charge
+      autoload :Pix, "kobana_ruby_client/resources/charge/pix"
+      autoload :BankBillet, "kobana_ruby_client/resources/charge/bank_billet"
+    end
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: kobana
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kivanio Barbosa
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-01-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Kobana API Client
+email:
+- kivanio@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- Rakefile
+- lib/kobana_ruby_client.rb
+- lib/kobana_ruby_client/base.rb
+- lib/kobana_ruby_client/configuration.rb
+- lib/kobana_ruby_client/resources/charge/bank_billet.rb
+- lib/kobana_ruby_client/resources/charge/pix.rb
+- lib/kobana_ruby_client/resources/resource_operations.rb
+- lib/kobana_ruby_client/version.rb
+homepage: https://www.kobana.com.br/
+licenses: []
+metadata:
+  homepage_uri: https://github.com/universokobana/kobana-ruby-client
+  changelog_uri: https://github.com/universokobana/kobana-ruby-client/releases
+  source_code_uri: https://github.com/universokobana/kobana-ruby-client
+  bug_tracker_uri: https://github.com/universokobana/kobana-ruby-client/issues
+  documentation_uri: https://github.com/universokobana/kobana-ruby-client/wiki
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.6
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.23
+signing_key:
+specification_version: 4
+summary: Kobana API Client
+test_files: []