openpix-ruby_sdk 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 568304637b2105328d5baccbea435111c0df6f9fba29398e5a228feb738df2da
-  data.tar.gz: 3be1e2e0f40aff2293260907aa40cf83a2483b0cdbcb9ee99e9798192c392c7e
+  metadata.gz: efe2aa84bfbd12ee2ba2cc447ac1861f0698a9b6447e4306ac0e8ac40d937de2
+  data.tar.gz: abd20ecbf7f22d10c6515c109484e2f317ffd98c91525e5ada0f6a81f544f29b
 SHA512:
-  metadata.gz: afaa3a60b4cc720c3e600e5c3bbc7ea27dea597cbb9be47a6d31ceb1700ee597f2b447991f2b3562b4e4c7e5499018e4d473ed11d63d4b264ebb54ff6269fc0d
-  data.tar.gz: ff6414815c729bfe36d012f9ce65ef163fe97de088627d2a0290321b25541593345429ddb772ed02ecaa94865c8c6a553a1f88b5f6237f73ae1ac952ab18ebaa
+  metadata.gz: 575e19123b1bd5ade726154dd4ab10109766a7c643df7c0cdb585bf995873625498a4598de25d2921eaab52aad6b18530e0c3a94f88365317c0630e987388dcc
+  data.tar.gz: 875d6302b1e7d140ba981a907afd598eaf3cb2a07cb32c4d7e2424f8b93f6dc9b88794526a05d7f49068b490d37a644c65d5717d0a9d020a9f2893c8ec35bc5a

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 ## [Unreleased]
 
+## [2.0.0](https://github.com/Open-Pix/ruby-sdk/compare/v1.2.0...v2.0.0) (2023-07-24)
+
+
+### ⚠ BREAKING CHANGES
+
+* Refactor resources params to reflect better API payload structure ([#29](https://github.com/Open-Pix/ruby-sdk/issues/29))
+
+### Bug Fixes
+
+* Refactor resources params to reflect better API payload structure ([#29](https://github.com/Open-Pix/ruby-sdk/issues/29)) ([c03692a](https://github.com/Open-Pix/ruby-sdk/commit/c03692acc02e83d66f3884a1d49d03941bc8a221))
+
 ## [1.2.0](https://github.com/Open-Pix/ruby-sdk/compare/v1.1.1...v1.2.0) (2023-07-04)
 
 

data/README.md

@@ -1,24 +1,32 @@
 # OpenPix/Woovi Ruby SDK
+
 Welcome to the Woovi Ruby SDK! This SDK provides convenient access to the Woovi REST API, allowing you to easily integrate Woovi's REST API into your Ruby applications.
 
 ## Documentation
+
 Documentation for Woovi REST API can be found [here](https://developers.woovi.com/api).
 RDoc documentation for classes included in the gem can be found [here]().
 
 ## Installation
+
 To install this gem using Bundler, add this following line to your `Gemfile`.
+
 ```shell
 gem 'openpix-ruby_sdk', '~> 0.1.0'
 ```
 
 To manually install `openpix-ruby_sdk` via Rubygems simply:
+
 ```shell
 gem install openpix-ruby_sdk -v 1.0.0
 ```
 
 ## Usage
+
 Main class `openpix/ruby_sdk/client` is your entrypoint to the endpoints.
+
 ### Authenticating client
+
 ```ruby
 require 'openpix/ruby_sdk'
 
@@ -27,9 +35,12 @@ app_id = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
 
 client = Openpix::RubySdk::Client.new(app_id)
 ```
+
 ### Using resources
-`Openpix::RubySdk::Client` has access to all resources available through a accessor method with resource name in plural form   
+
+`Openpix::RubySdk::Client` has access to all resources available through a accessor method with resource name in plural form
 E.g: Charge -> client.charges (returns the charge resource class with all available methods)
+
 ```ruby
 # Creating a Charge
 client.charges.init_body(
@@ -70,27 +81,33 @@ response = client.charges.find(id: 'my-charge-id')
 response = client.charges.destroy(id: 'my-charge-id')
 response.success? # this operations just returns success
 ```
+
 ### Available resources
+
 The available resources are:
+
 - Charge (charges)
 - Customer (customers)
 - Payment (payments)
 - Refund (refunds)
 - Subscription (subscriptions)
 - Webhook (webhooks)
+
 ### Handling errors
-All available resource methods have their bang! version, which raises an error whenever something goes wrong so you can properly handle those cases   
+
+All available resource methods have their bang! version, which raises an error whenever something goes wrong so you can properly handle those cases
 All errors have some helpful message, showing response status and error response from API
 
-Error classes are:   
-**save!** -> `Openpix::RubySdk::Resources::RequestError`   
-**fetch!** -> `Openpix::RubySdk::Resources::RequestError`   
-**fetch_next_page!** -> `Openpix::RubySdk::Resources::RequestError`, `Openpix::RubySdk::Resources::NotFetchedError`, `Openpix::RubySdk::Resources::PageNotDefinedError`   
-**fetch_previous_page!** -> `Openpix::RubySdk::Resources::RequestError`, `Openpix::RubySdk::Resources::NotFetchedError`, `Openpix::RubySdk::Resources::PageNotDefinedError`   
-**find!** -> `Openpix::RubySdk::Resources::RequestError`   
-**destroy!** -> `Openpix::RubySdk::Resources::RequestError`   
+Error classes are:
+**save!** -> `Openpix::RubySdk::Resources::RequestError`
+**fetch!** -> `Openpix::RubySdk::Resources::RequestError`
+**fetch_next_page!** -> `Openpix::RubySdk::Resources::RequestError`, `Openpix::RubySdk::Resources::NotFetchedError`, `Openpix::RubySdk::Resources::PageNotDefinedError`
+**fetch_previous_page!** -> `Openpix::RubySdk::Resources::RequestError`, `Openpix::RubySdk::Resources::NotFetchedError`, `Openpix::RubySdk::Resources::PageNotDefinedError`
+**find!** -> `Openpix::RubySdk::Resources::RequestError`
+**destroy!** -> `Openpix::RubySdk::Resources::RequestError`
 
 For the safe version (without bang!) there will be an `error_response` attribute setted in the API response whenever `success?` is false.
+
 ```ruby
 response = client.customers.save
 
@@ -100,47 +117,11 @@ end
 ```
 
 ## Contributing
-We welcome contributions to the Woovi Ruby SDK! If you would like to contribute, please follow these steps:
-
-- Fork the repository
-- Create a new branch for your feature or bug fix
-- Write your code and tests
-- Commit your changes and push your branch to GitHub
-- Submit a pull request
-
-Please make sure to adhere to the [code of conduct](#code-of-conduct).
-
-## Code of Conduct
-Our Pledge
-We pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
 
-Our Standards
-Examples of behavior that contributes to creating a positive environment include:
+If you have suggestions for how Woovi Ruby SDK could be improved, or want to report a bug, open an issue! We'd love all and any contributions.
 
-Using welcoming and inclusive language
-Being respectful of differing viewpoints and experiences
-Gracefully accepting constructive criticism
-Focusing on what is best for the community
-Showing empathy towards other community members
-Examples of unacceptable behavior by participants include:
-
-The use of sexualized language or imagery and unwelcome sexual attention or advances
-Trolling, insulting/derogatory comments, and personal or political attacks
-Public or private harassment
-Publishing others' private information, such as a physical or electronic address, without explicit permission
-Other conduct which could reasonably be considered inappropriate in a professional setting
-Our Responsibilities
-As project maintainers, we are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
-
-As contributors, you have the responsibility to adhere to these standards and report any instances of unacceptable behavior.
-
-Enforcement
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the project team at <developers@woovi.com>. The project team will review and investigate all complaints and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the code of conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
-
-Attribution
-This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at http://contributor-covenant.org/version/1/4.
+For more, check out the [Contributing Guide](CONTRIBUTING.md).
 
 ## License
-MIT License.
+
+Woovi Ruby SDK is distributed under the terms of the [MIT license](LICENSE).

data/lib/openpix/ruby_sdk/api_body_formatter.rb

@@ -8,25 +8,11 @@ module Openpix
     # Helper class to format body params before request
     class ApiBodyFormatter
       class << self
-        def format_entity_param(entity)
-          formatted_entity = {}
-
-          entity.each do |attr, value|
-            formatted_entity[transform_id_pattern(attr)] = value
-          end
-
-          remove_empty_values(formatted_entity)
-        end
-
         def remove_empty_values(entity)
           entity.compact.reject do |_key, value|
             value.empty? if value.respond_to?(:empty?)
           end
         end
-
-        def transform_id_pattern(attr_key)
-          attr_key.camelize(:lower).gsub('Id', 'ID')
-        end
       end
     end
   end

data/lib/openpix/ruby_sdk/resources/charge.rb

@@ -9,18 +9,18 @@ module Openpix
       # Make API operations on Charge resource
       class Charge < Resource
         ATTRS = %w[
-          correlation_id
+          correlationID
           value
           type
           comment
           identifier
-          expires_in
+          expiresIn
           customer
-          days_for_due_date
-          days_after_due_date
+          daysForDueDate
+          daysAfterDueDate
           interests
           fines
-          additional_info
+          additionalInfo
         ].freeze
 
         attr_accessor(*ATTRS)
@@ -47,11 +47,11 @@ module Openpix
 
           return body if body['customer'].nil? || body['customer'].empty?
 
-          body['customer'] = Openpix::RubySdk::ApiBodyFormatter.format_entity_param(body['customer'])
+          body['customer'] = Openpix::RubySdk::ApiBodyFormatter.remove_empty_values(body['customer'])
 
           return body if body['customer']['address'].nil? || body['customer']['address'].empty?
 
-          customer_address_parsed = Openpix::RubySdk::ApiBodyFormatter.format_entity_param(body['customer']['address'])
+          customer_address_parsed = Openpix::RubySdk::ApiBodyFormatter.remove_empty_values(body['customer']['address'])
           body['customer'] = body['customer'].merge({ 'address' => customer_address_parsed })
 
           body
@@ -61,9 +61,9 @@ module Openpix
         # @param key [String] the key
         # @param value [String] the value
         def add_additional_info(key, value)
-          @additional_info = [] if @additional_info.nil?
+          @additionalInfo = [] if @additionalInfo.nil?
 
-          @additional_info << { 'key' => key, 'value' => value }
+          @additionalInfo << { 'key' => key, 'value' => value }
         end
 
         # set interests configuration for creating this resource

data/lib/openpix/ruby_sdk/resources/customer.rb

@@ -12,8 +12,8 @@ module Openpix
           name
           email
           phone
-          tax_id
-          correlation_id
+          taxID
+          correlationID
           address
         ].freeze
 
@@ -38,7 +38,7 @@ module Openpix
 
           return body if body['address'].nil? || body['address'].empty?
 
-          body['address'] = Openpix::RubySdk::ApiBodyFormatter.format_entity_param(body['address'])
+          body['address'] = Openpix::RubySdk::ApiBodyFormatter.remove_empty_values(body['address'])
 
           body
         end

data/lib/openpix/ruby_sdk/resources/payment.rb

@@ -12,10 +12,10 @@ module Openpix
       class Payment < Resource
         ATTRS = %w[
           value
-          destination_alias
-          correlation_id
+          destinationAlias
+          correlationID
           comment
-          source_account_id
+          sourceAccountId
         ].freeze
 
         attr_accessor(*ATTRS)
@@ -34,16 +34,6 @@ module Openpix
           'payment'
         end
 
-        def to_body
-          body = super
-
-          return body unless body['sourceAccountID']
-
-          body['sourceAccountId'] = body['sourceAccountID']
-
-          body.except('sourceAccountID')
-        end
-
         # rubocop:disable Lint/UnusedMethodArgument
         def destroy(id:)
           raise(

data/lib/openpix/ruby_sdk/resources/refund.rb

@@ -12,8 +12,8 @@ module Openpix
       class Refund < Resource
         ATTRS = %w[
           value
-          transaction_end_to_end_id
-          correlation_id
+          transactionEndToEndId
+          correlationID
           comment
         ].freeze
 
@@ -33,16 +33,6 @@ module Openpix
           'refund'
         end
 
-        def to_body
-          body = super
-
-          return body unless body['transactionEndToEndID']
-
-          body['transactionEndToEndId'] = body['transactionEndToEndID']
-
-          body.except('transactionEndToEndID')
-        end
-
         # rubocop:disable Lint/UnusedMethodArgument
         def destroy(id:)
           raise(

data/lib/openpix/ruby_sdk/resources/resource.rb

@@ -70,7 +70,7 @@ module Openpix
           body = {}
 
           create_attributes.each do |attr|
-            body[Openpix::RubySdk::ApiBodyFormatter.transform_id_pattern(attr)] = send(attr)
+            body[attr] = send(attr)
           end
 
           compacted_body = Openpix::RubySdk::ApiBodyFormatter.remove_empty_values(body)

data/lib/openpix/ruby_sdk/resources/subscription.rb

@@ -10,8 +10,9 @@ module Openpix
       class Subscription < Resource
         ATTRS = %w[
           value
-          day_generate_charge
+          dayGenerateCharge
           customer
+          chargeType
         ].freeze
 
         attr_accessor(*ATTRS)
@@ -39,7 +40,7 @@ module Openpix
 
           return body if body['customer'].nil? || body['customer'].empty?
 
-          body['customer'] = Openpix::RubySdk::ApiBodyFormatter.format_entity_param(body['customer'])
+          body['customer'] = Openpix::RubySdk::ApiBodyFormatter.remove_empty_values(body['customer'])
 
           body
         end

data/lib/openpix/ruby_sdk/resources/webhook.rb

@@ -12,7 +12,7 @@ module Openpix
           event
           url
           authorization
-          is_active
+          isActive
         ].freeze
 
         attr_accessor(*ATTRS)

data/lib/openpix/ruby_sdk/version.rb

@@ -2,6 +2,6 @@
 
 module Openpix
   module RubySdk
-    VERSION = '1.2.0'
+    VERSION = '2.0.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openpix-ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Erick Takeshi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-04 00:00:00.000000000 Z
+date: 2023-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport