conexa 0.1.0 → 0.2.0

data/lib/conexa/resources/recurring_sale.rb

@@ -4,13 +4,23 @@ module Conexa
   class RecurringSale < Model
     primary_key_attribute :recurring_sale_id
 
-    # End/terminate a recurring sale
-    # @param params [Hash] optional parameters (e.g., endDate)
+    # Set this recurring sale's end date — closing it, or amending an existing
+    # closure.
+    #
+    # Like the contract endpoint, this one is documented as "encerra uma venda
+    # recorrente ativa **ou atualiza a data de encerramento**".
+    #
+    # @param params [Hash]
+    # @option params [String] :date required, yyyy-MM-dd — the closing date
+    # @option params [String] :end_date deprecated alias for +:date+; the API
+    #   rejects the +endDate+ it camelizes to
     # @return [self]
     def end_recurring_sale(params = {})
-      Conexa::Request.post(self.class.show_url("end", primary_key), params: params).call(class_name)
+      params = Util.normalize_end_date_param(params)
+      Conexa::Request.patch(self.class.show_url("end", primary_key), params: params).call(class_name)
       self
     end
+    alias_method :set_end_date, :end_recurring_sale
 
     class << self
       def url(*params)
@@ -21,13 +31,14 @@ module Conexa
         ["/recurringSale", *params].join '/'
       end
 
-      # End a recurring sale by ID
+      # Set a recurring sale's end date by ID
+      # @see #end_recurring_sale
       # @param id [Integer, String] recurring sale ID
-      # @param params [Hash] optional parameters (e.g., endDate)
       # @return [RecurringSale]
       def end_recurring_sale(id, params = {})
         find(id).end_recurring_sale(params)
       end
+      alias_method :set_end_date, :end_recurring_sale
     end
   end
 end

data/lib/conexa/resources/result.rb

@@ -18,19 +18,37 @@ module Conexa
       @attributes["pagination"]
     end
 
+    # @return [Boolean] always a boolean — it used to yield nil when there was no
+    #   pagination at all, which is falsy but not `false`, and leaks out of any
+    #   caller that serialises or compares the result.
     def has_next?
-      pagination && pagination.has_next == true
+      pagination.respond_to?(:has_next) && pagination.has_next == true
     end
 
     def next_page
       raise StopIteration, "No more pages" unless has_next?
-      raise "No query context available for next_page" unless @query_context
+      raise Conexa::RequestError, "No query context available for next_page" unless @query_context
+
+      limit  = pagination.limit
+      offset = pagination.offset
+      unless limit.is_a?(Integer) && offset.is_a?(Integer)
+        raise Conexa::ResponseError.new(@query_context[:params], nil,
+                                        "pagination is missing limit/offset " \
+                                        "(limit=#{limit.inspect}, offset=#{offset.inspect}), " \
+                                        "so the next page cannot be computed")
+      end
 
       resource_class = @query_context[:resource_class]
-      next_params = Marshal.load(Marshal.dump(@query_context[:params]))
 
-      next_params[:limit] = pagination.limit
-      next_params[:offset] = pagination.offset + pagination.limit
+      begin
+        next_params = Marshal.load(Marshal.dump(@query_context[:params]))
+      rescue TypeError
+        # A non-marshallable filter (a Proc, an IO) in the original query.
+        next_params = @query_context[:params].dup
+      end
+
+      next_params[:limit] = limit
+      next_params[:offset] = offset + limit
       next_params.delete(:page)
       next_params.delete(:size)
 

data/lib/conexa/util.rb

@@ -47,25 +47,62 @@ module Conexa
         string.to_s.strip.gsub(/[\s\-]+/, '_').to_sym
       end
 
+      # Both "end" endpoints — PATCH /contract/end/:id and
+      # PATCH /recurringSale/end/:id — document the closing date as `date`. The
+      # gem used to send `end_date`, which camelizes to `endDate` and is rejected:
+      # "endDate field does not exist or is not available in the company".
+      #
+      # Both key spellings are handled, and both are removed. Checking only the
+      # symbol `:date` would leave a caller's string `"date"` in place and add a
+      # second, colliding key — camelize_hash folds the two into one and the last
+      # one wins, so the deprecated value would silently replace the real one.
+      #
+      # @param params [Hash] caller params, possibly using the old name
+      # @return [Hash] a copy with end_date folded into date
+      def normalize_end_date_param(params)
+        params = params.dup
+
+        # Collapse both spellings of each key up front. Leaving one behind would
+        # let camelize_hash fold two `date` keys into one, last-write-wins — which
+        # is how the deprecated value once silently replaced the real one.
+        legacy   = [params.delete(:end_date), params.delete("end_date")].compact.first
+        explicit = [params.delete(:date), params.delete("date")].compact.first
+
+        if legacy
+          warn "DEPRECATION WARNING: `end_date:` foi renomeado para `date:` em conexa 0.2.0 " \
+               "(a API v2 rejeita `endDate`). O alias será removido em 0.3.0."
+        end
+
+        # An explicit date wins; a key present with a nil value is not one.
+        date = explicit || legacy
+        params[:date] = date unless date.nil?
+        params
+      end
+
       def to_snake_case str
         str.gsub(/([A-Z])/, '_\1').downcase.sub(/^_/, '')
       end
 
 
+      # Convert a payload's keys to the camelCase the API expects, all the way
+      # down. Arrays of objects matter as much as nested hashes: ten documented
+      # endpoints take them (complementaryServices, productQuotas, devices,
+      # extraFields, bookingModels, visitors, costCenters, ...), and a snake_case
+      # key inside one is rejected outright.
       def camelize_hash(hash)
         return {} if hash.nil?
 
-        new_hash = {}
-
-        hash.each do |key, value|
-          if value.is_a?(Hash)
-            new_hash[camel_case_lower(key).to_sym] = camelize_hash(value)
-          else
-            new_hash[camel_case_lower(key).to_sym] = value
-          end
+        hash.each_with_object({}) do |(key, value), new_hash|
+          new_hash[camel_case_lower(key).to_sym] = camelize_value(value)
         end
+      end
 
-        new_hash
+      def camelize_value(value)
+        case value
+        when Hash  then camelize_hash(value)
+        when Array then value.map { |element| camelize_value(element) }
+        else value
+        end
       end
 
       def camelize_str(str)

data/lib/conexa/version.rb

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

data/lib/conexa.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require_relative "conexa/version"
-require_relative "conexa/authenticator"
 require_relative "conexa/request"
 require_relative "conexa/object"
 require_relative "conexa/model"
@@ -9,8 +8,6 @@ require_relative "conexa/core_ext"
 require_relative "conexa/errors"
 require_relative "conexa/util"
 require_relative "conexa/configuration"
-require_relative "conexa/order_common"
-require_relative "conexa/token_manager"
 
 
 Dir[File.expand_path('../conexa/resources/*.rb', __FILE__)].map do |path|
@@ -32,4 +29,42 @@ module Conexa
   def self.api_endpoint
     configuration.api_host + "/index.php/api/v2"
   end
+
+  # Key for the block-scoped read-only override. Thread-local so a guarded block
+  # in one thread cannot relax or tighten another.
+  READ_ONLY_KEY = :conexa_read_only
+
+  # Is writing currently forbidden?
+  #
+  # True inside a {read_only} block, or whenever `configuration.read_only` is set
+  # (which itself defaults from CONEXA_READ_ONLY).
+  #
+  # @return [Boolean]
+  def self.read_only?
+    scoped = Thread.current[READ_ONLY_KEY]
+    return scoped unless scoped.nil?
+
+    !!configuration&.read_only
+  end
+
+  # Run a block with writes forbidden, then restore the previous state.
+  #
+  # Useful for auditing or reporting code that should never mutate a tenant,
+  # without having to reconfigure the client globally.
+  #
+  # @example
+  #   Conexa.read_only do
+  #     Conexa::Charge.all(status: "pending")   # fine
+  #     Conexa::Charge.settle(555)              # raises Conexa::ReadOnlyError
+  #   end
+  #
+  # @param enabled [Boolean] pass false to explicitly allow writes in the block
+  # @return [Object] the block's return value
+  def self.read_only(enabled = true)
+    previous = Thread.current[READ_ONLY_KEY]
+    Thread.current[READ_ONLY_KEY] = enabled
+    yield
+  ensure
+    Thread.current[READ_ONLY_KEY] = previous
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: conexa
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Guilherme Gazzinelli
@@ -9,118 +9,90 @@ bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: jwt
-  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'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: debug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: faker
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6.0'
 description: Gem para integração com a Conexa
 email:
 - guilherme.gazzinelli@gmail.com
@@ -128,32 +100,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".editorconfig"
-- ".rspec"
-- ".rubocop.yml"
-- ".solargraph.yml"
-- ".vscode/launch.json"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
-- Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - README_pt-BR.md
 - REFERENCE.md
-- Rakefile
-- bin/console
-- bin/setup
-- docs/postman-collection.json
 - lib/conexa.rb
-- lib/conexa/authenticator.rb
 - lib/conexa/configuration.rb
 - lib/conexa/core_ext.rb
 - lib/conexa/errors.rb
 - lib/conexa/generators/install_generator.rb
 - lib/conexa/model.rb
 - lib/conexa/object.rb
-- lib/conexa/order_common.rb
 - lib/conexa/request.rb
 - lib/conexa/resources/account.rb
 - lib/conexa/resources/address.rb
@@ -181,10 +140,8 @@ files:
 - lib/conexa/resources/sale.rb
 - lib/conexa/resources/service_category.rb
 - lib/conexa/resources/supplier.rb
-- lib/conexa/token_manager.rb
 - lib/conexa/util.rb
 - lib/conexa/version.rb
-- scripts/extract_fixtures.rb
 homepage: https://github.com/guilhermegazzinelli/conexa-ruby
 licenses:
 - MIT
@@ -199,14 +156,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.16
 specification_version: 4
 summary: Gem para integração com a Api da Conexa
 test_files: []

data/.editorconfig

@@ -1,30 +0,0 @@
-root = true
-
-[*]
-end_of_line = lf
-indent_size = 2
-indent_style = space
-insert_final_newline = true
-tab_width = 4
-trim_trailing_whitespace = true
-
-[*.bat]
-end_of_line = crlf
-
-[*.gemspec]
-indent_size = 2
-
-[*.rb]
-indent_size = 2
-
-[*.yml]
-indent_size = 2
-
-[{*[Mm]akefile*,*.mak,*.mk,depend}]
-indent_style = tab
-
-[enc/*]
-indent_size = 2
-
-[reg*.[ch]]
-indent_size = 2

data/.rspec

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

data/.rubocop.yml

@@ -1,13 +0,0 @@
-AllCops:
-  TargetRubyVersion: 2.6
-
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Layout/LineLength:
-  Max: 120

data/.solargraph.yml

@@ -1,2 +0,0 @@
-include:
-- "lib/*.rb"

data/.vscode/launch.json

@@ -1,30 +0,0 @@
-{
-    // Use IntelliSense to learn about possible attributes.
-    // Hover to view descriptions of existing attributes.
-    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-    "version": "0.2.0",
-    "configurations": [
-
-       {
-      "name": "Run console",
-      "debugPort": "9999",
-      "request": "launch",
-      "script": "${workspaceRoot}/bin/console",
-      "type": "rdbg",
-      "useTerminal": true,
-      "rdbgPath": "bundle exec rdbg",
-
-      "args": []
-    },
-    {
-      "name": "Run rspec",
-      "request": "launch",
-      "script": "respec",
-      "type": "rdbg",
-      "useTerminal": true,
-      "rdbgPath": "bundle exec rdbg",
-
-      "args": []
-    }
-    ]
-}

data/Gemfile

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in conexa.gemspec
-gemspec
-
-gem "rake", "~> 13.0"
-
-gem "rspec", "~> 3.0"
-
-gem "rubocop", "~> 1.21"
-
-gem "standard"
-
-gem "debug"
-gem "byebug"
-