nova-pay-grpc 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3ea929047d15cce58bde5426cc965ce9b90ca634ff5caa48fd0374c634a36eab
+  data.tar.gz: 70b6b4a208019b46c070f40f384945bab9f74bb37ae986a5a011256870a3c603
+SHA512:
+  metadata.gz: df2a394158b4e4d6fb12d83e26f81122b3df09f3a21d276b921daf840150d871033fde967100e4d10f05e34b3cb28dd7535412cc746dfe0c9cc2be963b927a2a
+  data.tar.gz: 7f5df26fc0e0390686c0d056df7ddc5788bf2712a0d11498661f9591f5802ec22f9a761586ddc742f8e27f46e31ab3fe4ce4fec7de6f4f0d09eec2ba62e95993

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Unreleased
+
+## 1.0.0 - 2026-01-06
+
+### Added
+
+- Initial release of the `nova-pay-grpc` gem, providing shared gRPC proto definitions and Ruby stubs for Nova Pay services.
+- `CheckoutService` with `perform` RPC for handling checkout requests.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Coyô Software
+
+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,80 @@
+# Nova Pay gRPC
+
+Shared gRPC proto definitions and Ruby stubs for Nova Pay services.
+
+This gem provides the necessary files to interact with Nova Pay's gRPC services. It includes the generated Ruby code from the `.proto` files, which define the services and messages.
+
+## Technologies Used
+
+*   **Ruby:** The primary language for the generated gRPC client code.
+*   **gRPC:** The RPC framework used for communication between services.
+*   **Protocol Buffers:** The data serialization format used by gRPC.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nova-pay-grpc'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install nova-pay-grpc
+
+## Usage
+
+This gem provides a client for the `CheckoutService`. Here's a basic example of how to use it:
+
+```ruby
+require 'nova/pay/v1/checkout_services_pb'
+
+# Create a stub for the CheckoutService
+stub = Nova::Pay::V1::CheckoutService::Stub.new('localhost:50051', :this_channel_is_insecure)
+
+# Create a request object
+request = Nova::Pay::V1::CheckoutRequest.new(
+  date: Google::Protobuf::Timestamp.new(seconds: Time.now.to_i),
+  checkout_page_id: 'your-checkout-page-id',
+  payment_plan_id: 1,
+  installments: 1,
+  customer: Nova::Pay::V1::CustomerInput.new(
+    email: 'customer@example.com',
+    name: 'John Doe',
+    identification: '12345678900',
+    phone: '5511999999999',
+    zipcode: '12345678',
+    street: 'Main Street',
+    number: '123',
+    neighborhood: 'Downtown',
+    city: 'Anytown',
+    state: 'AN',
+  ),
+  items: [
+    Nova::Pay::V1::CheckoutItem.new(
+      product_id: 1,
+      quantity: 1
+    )
+  ]
+)
+
+# Make the RPC call
+begin
+  response = stub.perform(request)
+  p response
+rescue GRPC::BadStatus => e
+  puts "Error: #{e.details}"
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/coyosoftware/nova-pay-grpc.
+
+## 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,15 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+
+task :default do
+  proto_root = 'proto'
+  out_dir = 'lib'
+
+  Dir.glob("#{proto_root}/**/*.proto").each do |proto|
+    sh <<~CMD
+      grpc_tools_ruby_protoc -I #{proto_root} --ruby_out=#{out_dir} --grpc_out=#{out_dir} #{proto}
+    CMD
+  end
+end
+

data/lib/nova/pay/grpc/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Nova
+  module Pay
+    module Grpc
+      VERSION = "1.0.0"
+    end
+  end
+end

data/lib/nova/pay/grpc.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "grpc/version"
+
+require "grpc"
+require 'google/protobuf'
+require 'google/protobuf/well_known_types'
+
+require "nova/pay/v1/checkout_pb"
+require "nova/pay/v1/checkout_services_pb"

data/lib/nova/pay/v1/checkout_pb.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: nova/pay/v1/checkout.proto
+
+require 'google/protobuf'
+
+require 'google/protobuf/struct_pb'
+require 'google/protobuf/timestamp_pb'
+
+
+descriptor_data = "\n\x1anova/pay/v1/checkout.proto\x12\x0bnova.pay.v1\x1a\x1cgoogle/protobuf/struct.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"\xf1\x02\n\x0f\x43heckoutRequest\x12(\n\x04\x64\x61te\x18\x01 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12\x18\n\x0bobservation\x18\x02 \x01(\tH\x00\x88\x01\x01\x12\x18\n\x10\x63heckout_page_id\x18\x03 \x01(\t\x12\x17\n\x0fpayment_plan_id\x18\x04 \x01(\x03\x12\x14\n\x0cinstallments\x18\x05 \x01(\x03\x12,\n\x08\x63ustomer\x18\x06 \x01(\x0b\x32\x1a.nova.pay.v1.CustomerInput\x12(\n\x05items\x18\x07 \x03(\x0b\x32\x19.nova.pay.v1.CheckoutItem\x12\x34\n\x0c\x63redit_cards\x18\x08 \x03(\x0b\x32\x1e.nova.pay.v1.CreditCardPayment\x12*\n\x04meta\x18\t \x01(\x0b\x32\x17.google.protobuf.StructH\x01\x88\x01\x01\x42\x0e\n\x0c_observationB\x07\n\x05_meta\"\x80\x02\n\rCustomerInput\x12\r\n\x05\x65mail\x18\x01 \x01(\t\x12\x16\n\x0eidentification\x18\x02 \x01(\t\x12\x0c\n\x04name\x18\x03 \x01(\t\x12\x14\n\x0cneighborhood\x18\x04 \x01(\t\x12\x0e\n\x06number\x18\x05 \x01(\t\x12\r\n\x05phone\x18\x06 \x01(\t\x12\x0e\n\x06street\x18\x07 \x01(\t\x12\x0f\n\x07zipcode\x18\x08 \x01(\t\x12\r\n\x05state\x18\t \x01(\t\x12\x0c\n\x04\x63ity\x18\n \x01(\t\x12\x12\n\ncomplement\x18\x0b \x01(\t\x12*\n\x04meta\x18\x0c \x01(\x0b\x32\x17.google.protobuf.StructH\x00\x88\x01\x01\x42\x07\n\x05_meta\"h\n\x0c\x43heckoutItem\x12\x12\n\nproduct_id\x18\x01 \x01(\x03\x12\x10\n\x08quantity\x18\x02 \x01(\x05\x12\x1d\n\x10unit_value_cents\x18\x03 \x01(\x03H\x00\x88\x01\x01\x42\x13\n\x11_unit_value_cents\"x\n\x11\x43reditCardPayment\x12\r\n\x05token\x18\x01 \x01(\t\x12\x0f\n\x07\x63\x61rd_id\x18\x02 \x01(\t\x12\x17\n\x0fpayment_plan_id\x18\x03 \x01(\x03\x12\x14\n\x0cinstallments\x18\x04 \x01(\x05\x12\x14\n\x0c\x61mount_cents\x18\x05 \x01(\x03\"T\n\x10\x43heckoutResponse\x12\x0f\n\x07success\x18\x01 \x01(\x08\x12/\n\x04\x64\x61ta\x18\x03 \x01(\x0b\x32!.nova.pay.v1.CheckoutResponseData\"\xd1\x01\n\x14\x43heckoutResponseData\x12.\n\x0corder_status\x18\x01 \x01(\x0e\x32\x18.nova.pay.v1.OrderStatus\x12\x10\n\x08payments\x18\x02 \x03(\t\x12\x15\n\rbank_slip_url\x18\x03 \x01(\t\x12\x13\n\x0bpix_qr_code\x18\x04 \x01(\t\x12\x17\n\x0fpix_qr_code_url\x18\x05 \x01(\t\x12\x32\n\x0epix_expires_at\x18\x06 \x01(\x0b\x32\x1a.google.protobuf.Timestamp*\xf6\x01\n\x0bOrderStatus\x12\x18\n\x14ORDER_STATUS_PENDING\x10\x00\x12 \n\x1cORDER_STATUS_WAITING_PAYMENT\x10\x01\x12\x1f\n\x1bORDER_STATUS_PARTIALLY_PAID\x10\x02\x12\x15\n\x11ORDER_STATUS_PAID\x10\x03\x12\x1a\n\x16ORDER_STATUS_CANCELLED\x10\x04\x12#\n\x1fORDER_STATUS_PARTIALLY_REFUNDED\x10\x05\x12\x19\n\x15ORDER_STATUS_REFUNDED\x10\x06\x12\x17\n\x13ORDER_STATUS_BILLED\x10\x07\x32Y\n\x0f\x43heckoutService\x12\x46\n\x07perform\x12\x1c.nova.pay.v1.CheckoutRequest\x1a\x1d.nova.pay.v1.CheckoutResponseb\x06proto3"
+
+pool = ::Google::Protobuf::DescriptorPool.generated_pool
+pool.add_serialized_file(descriptor_data)
+
+module Nova
+  module Pay
+    module V1
+      CheckoutRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("nova.pay.v1.CheckoutRequest").msgclass
+      CustomerInput = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("nova.pay.v1.CustomerInput").msgclass
+      CheckoutItem = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("nova.pay.v1.CheckoutItem").msgclass
+      CreditCardPayment = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("nova.pay.v1.CreditCardPayment").msgclass
+      CheckoutResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("nova.pay.v1.CheckoutResponse").msgclass
+      CheckoutResponseData = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("nova.pay.v1.CheckoutResponseData").msgclass
+      OrderStatus = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("nova.pay.v1.OrderStatus").enummodule
+    end
+  end
+end

data/lib/nova/pay/v1/checkout_services_pb.rb

@@ -0,0 +1,26 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: nova/pay/v1/checkout.proto for package 'nova.pay.v1'
+
+require 'grpc'
+require 'nova/pay/v1/checkout_pb'
+
+module Nova
+  module Pay
+    module V1
+      module CheckoutService
+        class Service
+
+          include ::GRPC::GenericService
+
+          self.marshal_class_method = :encode
+          self.unmarshal_class_method = :decode
+          self.service_name = 'nova.pay.v1.CheckoutService'
+
+          rpc :perform, ::Nova::Pay::V1::CheckoutRequest, ::Nova::Pay::V1::CheckoutResponse
+        end
+
+        Stub = Service.rpc_stub_class
+      end
+    end
+  end
+end

data/proto/nova/pay/v1/checkout.proto

@@ -0,0 +1,78 @@
+syntax = "proto3";
+
+import "google/protobuf/struct.proto";
+import "google/protobuf/timestamp.proto";
+
+package nova.pay.v1;
+
+service CheckoutService {
+  rpc perform (CheckoutRequest) returns (CheckoutResponse);
+}
+
+enum OrderStatus {
+  ORDER_STATUS_PENDING = 0;
+  ORDER_STATUS_WAITING_PAYMENT = 1;
+  ORDER_STATUS_PARTIALLY_PAID = 2;
+  ORDER_STATUS_PAID = 3;
+  ORDER_STATUS_CANCELLED = 4;
+  ORDER_STATUS_PARTIALLY_REFUNDED = 5;
+  ORDER_STATUS_REFUNDED = 6;
+  ORDER_STATUS_BILLED = 7;
+}
+
+message CheckoutRequest {
+  google.protobuf.Timestamp date = 1;
+  optional string observation = 2;
+  string checkout_page_id = 3;
+  int64 payment_plan_id = 4;
+  int64 installments =  5;
+  CustomerInput customer = 6;
+  repeated CheckoutItem items = 7;
+  repeated CreditCardPayment credit_cards = 8;
+  optional google.protobuf.Struct meta = 9;
+}
+
+message CustomerInput {
+  string email = 1;
+  string identification = 2;
+  string name = 3;
+  string neighborhood = 4;
+  string number = 5;
+  string phone = 6;
+  string street = 7;
+  string zipcode = 8;
+  string state = 9;
+  string city = 10;
+  string complement = 11;
+  optional google.protobuf.Struct meta = 12;
+}
+
+message CheckoutItem {
+  int64 product_id = 1;
+  int32 quantity = 2;
+  optional int64 unit_value_cents = 3;
+}
+
+message CreditCardPayment {
+  string token = 1;
+  string card_id = 2;
+  int64 payment_plan_id = 3;
+  int32 installments = 4;
+  int64 amount_cents = 5;
+}
+
+message CheckoutResponse {
+  bool success = 1;
+  CheckoutResponseData data = 3;
+}
+
+message CheckoutResponseData {
+  OrderStatus order_status = 1;
+  repeated string payments = 2;
+  // Bank slip
+  string bank_slip_url = 3;
+  // Pix
+  string pix_qr_code = 4;
+  string pix_qr_code_url = 5;
+  google.protobuf.Timestamp pix_expires_at = 6;
+}

data/sig/nova/pay/grpc.rbs

@@ -0,0 +1,8 @@
+module Nova
+  module Pay
+    module Grpc
+      VERSION: String
+      # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+    end
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: nova-pay-grpc
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Coyô Software
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grpc-tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.76'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.76'
+- !ruby/object:Gem::Dependency
+  name: grpc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.76'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.76'
+email:
+- ti@coyo.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/nova/pay/grpc.rb
+- lib/nova/pay/grpc/version.rb
+- lib/nova/pay/v1/checkout_pb.rb
+- lib/nova/pay/v1/checkout_services_pb.rb
+- proto/nova/pay/v1/checkout.proto
+- sig/nova/pay/grpc.rbs
+homepage: https://github.com/coyosoftware/nova-pay-grpc
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/coyosoftware/nova-pay-grpc
+  source_code_uri: https://github.com/coyosoftware/nova-pay-grpc
+  changelog_uri: https://github.com/coyosoftware/nova-pay-grpc/blob/master/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.2
+specification_version: 4
+summary: Shared gRPC proto definitions and Ruby stubs for Nova Pay services.
+test_files: []