cobrato-client 0.26.0 → 0.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab666ea641bad0be10d7f5ab5951de0ac0cc9791
-  data.tar.gz: 1afee00451ab8769e03de88aad0fbd30b20eda19
+  metadata.gz: 6d909230cc248c276cf6e14e417062685d4ea161
+  data.tar.gz: 67526eeffba24270aebfa2220e9664448656d906
 SHA512:
-  metadata.gz: d3d4375130a23903c26b8cb670067da560412a81f7176cb149d9d341b29930e06e37f04c0b73ebec36ca3fe0b812c2445b9bdd64336788c942d7abcb752c79e9
-  data.tar.gz: 1b044d793aecf7e99e9d4782691736dec7b5745326b6968709e8c843bec6cb81a77988f8f3da090542465b1e5b2d73ebcaac65a2ae288a3754ff5faeafee90a2
+  metadata.gz: 94d90ba7e8b43dc639fd8bc141bc62e28eede68762827b0c3811363a7db21abb6ab984d9c7865ea92748fa3331cf9de2eaa71bbd554a66802d643562cb9ac2de
+  data.tar.gz: 02d9196f4612099e8254760e826812f40776eee86cd573317dc5c8e8ccfbd30b00a44e0c06f694d7bfb023e92f8f140da4fe7179e44594019d6de8b9a31fbbba

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## Next version
 
+## v0.27.0
+
+- Add `people` endpoints
+  - `payers#create` is now DEPRECATED. Use `people#create` instead
+  - `payers#list` is now DEPRECATED. Use `people#list` instead
+  - `payers#show` is now DEPRECATED. Use `people#show` instead
+  - `payers#update` is now DEPRECATED. Use `people#update` instead
+
 ## v0.26.0
 
 - Fix changing the RegressCnab and RemittaceCnab attribute `file_name` to `filename`

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cobrato-client (0.26.0)
+    cobrato-client (0.27.0)
       multi_json (~> 1.11)
       typhoeus (~> 0.8.0)
       virtus (~> 1.0.5)
@@ -27,7 +27,7 @@ GEM
     equalizer (0.0.11)
     ethon (0.11.0)
       ffi (>= 1.3.0)
-    ffi (1.9.23)
+    ffi (1.9.25)
     ice_nine (0.11.2)
     json (2.0.2)
     method_source (0.8.2)
@@ -84,4 +84,4 @@ DEPENDENCIES
   vcr (~> 2.9)
 
 BUNDLED WITH
-   1.16.1
+   1.16.2

data/README.md

@@ -52,7 +52,8 @@ Now you have acess to every API endpoint:
 
 * [Payees API](http://docs.cobrato.com/#benefici-rio)
 * [Bank Accounts API](http://docs.cobrato.com/#conta-banc-ria)
-* [Payers API](http://docs.cobrato.com/#pagador)
+* [People API](http://docs.cobrato.com/#pessoa)
+* [Payers API](http://docs.cobrato.com/#pagador) (DEPRECATED)
 * [Charge Configs API](http://docs.cobrato.com/#configura-o-de-cobran-a)
 * [Charges API](http://docs.cobrato.com/#cobran-a)
 * [Regress Cnab](http://docs.cobrato.com/#cnab-de-retorno)
@@ -85,7 +86,16 @@ Now you have acess to every API endpoint:
 | DELETE      | [api/v1/bank_accounts/:id](http://docs.cobrato.com/#exclus-o-de-conta-banc-ria)        | client.bank_accounts.destroy         |
 | GET         | [api/v1/bank_accounts/portfolio_codes](http://docs.cobrato.com/#carteiras-dispon-veis) | client.bank_accounts.portfolio_codes |
 
-#### [Payers](http://docs.cobrato.com/#pagador)
+#### [People](http://docs.cobrato.com/#pessoa)
+
+| HTTP method | Endpoint                                                            | Client method         |
+| ----------- | --------------------------------------------------------------------| --------------------- |
+| POST        | [api/v1/people](http://docs.cobrato.com/#cria-o-de-pessoa)          | client.people.create  |
+| GET         | [api/v1/people](http://docs.cobrato.com/#lista-de-todos-as-pessoas) | client.people.list    |
+| GET         | [api/v1/people/:id](http://docs.cobrato.com/#informa-es-da-pessoa)  | client.people.show    |
+| PUT         | [api/v1/people/:id](http://docs.cobrato.com/#atualiza-o-de-pessoa)  | client.people.update  |
+
+#### [Payers](http://docs.cobrato.com/#pagador) (DEPRECATED)
 
 | HTTP method | Endpoint                                                              | Client method         |
 | ----------- | --------------------------------------------------------------------- | --------------------- |

data/lib/cobrato.rb

@@ -12,6 +12,7 @@ require "cobrato/entities/base"
 require "cobrato/entities/cnab"
 require "cobrato/entities/payee"
 require "cobrato/entities/payer"
+require "cobrato/entities/person"
 require "cobrato/entities/bank_account"
 require "cobrato/entities/charge_config"
 require "cobrato/entities/payment_config"
@@ -27,6 +28,7 @@ require "cobrato/entities/charge_template"
 require "cobrato/resources/base"
 require "cobrato/resources/payee"
 require "cobrato/resources/payer"
+require "cobrato/resources/person"
 require "cobrato/resources/bank_account"
 require "cobrato/resources/charge_config"
 require "cobrato/resources/payment_config"

data/lib/cobrato/client.rb

@@ -63,6 +63,10 @@ module Cobrato
       Resources::Payer.new(http)
     end
 
+    def people
+      Resources::Person.new(http)
+    end
+
     def charge_templates
       Resources::ChargeTemplate.new(http)
     end

data/lib/cobrato/entities/payer.rb

@@ -12,6 +12,13 @@ module Cobrato
       attribute :number,                   String
       attribute :complement,               String
       attribute :street,                   String
+
+      %i[national_identifier name].each do |method|
+        define_method method do |*args|
+          puts "Warning: '#{self.class.name}##{method}' is deprecated. See API docs for more info."
+          super(*args)
+        end
+      end
     end
   end
-end
+end

data/lib/cobrato/entities/person.rb

@@ -0,0 +1,17 @@
+module Cobrato
+  module Entities
+    class Person < Base
+      attribute :id,                       Integer
+      attribute :national_identifier_type, String
+      attribute :national_identifier,      String
+      attribute :name,                     String
+      attribute :zipcode,                  String
+      attribute :city,                     String
+      attribute :state,                    String
+      attribute :neighbourhood,            String
+      attribute :number,                   String
+      attribute :complement,               String
+      attribute :street,                   String
+    end
+  end
+end

data/lib/cobrato/resources/base.rb

@@ -110,7 +110,7 @@ module Cobrato
 
 
       def underscore_pluralized(str)
-        "#{str.gsub(/(.)([A-Z])/, '\1_\2').downcase}s"
+        irregular_resource_name || "#{str.gsub(/(.)([A-Z])/, '\1_\2').downcase}s"
       end
 
       def deprecate(params, deprecated)
@@ -118,6 +118,9 @@ module Cobrato
           puts "Warning: The '#{a}' param is deprecated. See Cobrato API docs for more info."
         end
       end
+
+      # Define at child class when is irregular
+      def irregular_resource_name; end
     end
   end
 end

data/lib/cobrato/resources/payer.rb

@@ -2,6 +2,19 @@ module Cobrato
   module Resources
     class Payer < Base
       crud :show, :list, :create, :update
+
+      %w[show list create update].each do |method|
+        define_method method do |*args|
+          puts "Warning: The #{self.class.name}##{method} method is depracated. See Cobrato API docs for more info"
+          super(*args)
+        end
+      end
+
+      protected
+
+      def irregular_resource_name
+        "people"
+      end
     end
   end
-end
+end

data/lib/cobrato/resources/person.rb

@@ -0,0 +1,13 @@
+module Cobrato
+  module Resources
+    class Person < Base
+      crud :show, :list, :create, :update
+
+      protected
+
+      def irregular_resource_name
+        "people"
+      end
+    end
+  end
+end

data/lib/cobrato/version.rb

@@ -1,3 +1,3 @@
 module Cobrato
-  VERSION = '0.26.0'
+  VERSION = '0.27.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cobrato-client
 version: !ruby/object:Gem::Version
-  version: 0.26.0
+  version: 0.27.0
 platform: ruby
 authors:
 - Marcio Ricardo Santos
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-28 00:00:00.000000000 Z
+date: 2018-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -206,6 +206,7 @@ files:
 - lib/cobrato/entities/payer.rb
 - lib/cobrato/entities/payment.rb
 - lib/cobrato/entities/payment_config.rb
+- lib/cobrato/entities/person.rb
 - lib/cobrato/entities/regress_cnab.rb
 - lib/cobrato/entities/remittance_cnab.rb
 - lib/cobrato/entities/webhook.rb
@@ -224,6 +225,7 @@ files:
 - lib/cobrato/resources/payer.rb
 - lib/cobrato/resources/payment.rb
 - lib/cobrato/resources/payment_config.rb
+- lib/cobrato/resources/person.rb
 - lib/cobrato/resources/regress_cnab.rb
 - lib/cobrato/resources/remittance_cnab.rb
 - lib/cobrato/resources/webhook.rb
@@ -250,7 +252,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
 summary: This is the official Ruby client for the Cobrato API.