gerencianet 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ee4946e22787a2e68db5e903200acd21d2d557b
-  data.tar.gz: 28523c4cb5e7a860f1518b2ceeb119911a3bb7ef
+  metadata.gz: 63b2e15386a551a9a84b98b26d700cb13e181af3
+  data.tar.gz: 529d122d79349c92dd7a889fa5b76c6583698f00
 SHA512:
-  metadata.gz: 3a3a420dd6927b996b5953a0c55396792be78b4714e72cfa7d13bfb8e29675bcf8b9b9c86827dc668c8061bd74fcb3592e5ed5a2be07a74e446a0399202d370e
-  data.tar.gz: c85f93432d5d2cfc3098716c35e6e960fa4b199b458afe48bc0a5c9f296be8e86449d975e8c536515ee9e8c1b585be0eac9b7623a60f5f5a35aa9959234cd61a
+  metadata.gz: eb9f5875041bf748e2fdf18534da75658199c213a5aaac97434a5d65adf55f902144051343394c764d90706678149682abd6282421b02133ca97c925b6da0c29
+  data.tar.gz: 4a8f54c3f9f8b791790f45b221b63ef5328d27b542ac2cce8330be46692312cf1be4a6955be40b9f31b3608db8a3b7c903c05773e2140b9a3ff2661cf1a69ca2

data/.codeclimate.yml

@@ -0,0 +1,3 @@
+exclude_paths:
+  - docs/**/*
+  - spec/**/*

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.0.7
+
+- Added: Cancel carnet endpoint mapping
+- Added: Cancel parcel endpoint mapping
+- Updated: Docs and examples
+
 # 0.0.6
 
 - Added: Carnet resend/history endpoints mapping

data/README.md

@@ -8,9 +8,6 @@ provided by [Gerencianet](http://gerencianet.com.br).
 [![Code Climate](https://codeclimate.com/github/gerencianet/gn-api-sdk-ruby/badges/gpa.svg)](https://codeclimate.com/github/gerencianet/gn-api-sdk-ruby)
 [![Gem Version](https://badge.fury.io/rb/gerencianet.svg)](https://badge.fury.io/rb/gerencianet)
 
-:warning: **Gerencianet API is under BETA version, meaning that it's not available for all users right now. If you're interested, you can always send an email to
-desenvolvedores@gerencianet.com.br and we'll enable it for your account**
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -98,6 +95,8 @@ $ guard -n false -c
 - [Resending the carnet](https://github.com/gerencianet/gn-api-sdk-ruby/tree/master/docs/carnet-resend.md)
 - [Resending carnet parcel](https://github.com/gerencianet/gn-api-sdk-ruby/tree/master/docs/carnet-resend-parcel.md)
 - [Adding information to carnet's history](https://github.com/gerencianet/gn-api-sdk-ruby/tree/master/docs/carnet-create-history.md)
+- [Canceling the carnet](https://github.com/gerencianet/gn-api-sdk-ruby/tree/master/docs/carnet-cancel.md)
+- [Canceling carnet parcel](https://github.com/gerencianet/gn-api-sdk-ruby/tree/master/docs/carnet-cancel-parcel.md)
 
 ### Subscriptions
 

data/docs/carnet-cancel-parcel.md

@@ -0,0 +1,21 @@
+### Canceling a carnet parcel
+
+To cancel a carnet parcel, it must have status `waiting` or `unpaid`.
+
+```ruby
+params = {
+  id: 1000, 
+  parcel: 1
+}
+
+gerencianet = Gerencianet.new(options)
+puts gerencianet.cancel_parcel(params: params)
+```
+
+If everything goes well, the return will be:
+
+```ruby
+{
+  "code": 200
+}
+```

data/docs/carnet-cancel.md

@@ -0,0 +1,20 @@
+### Canceling the carnet
+
+Only `active` carnets can be canceled:
+
+```ruby
+params = {
+  id: 1000
+}
+
+gerencianet = Gerencianet.new(options)
+puts gerencianet.cancel_carnet(params: params)
+```
+
+If everything goes well, the return will be:
+
+```ruby
+{
+  "code": 200
+}
+```

data/docs/carnets.md

@@ -8,7 +8,6 @@ The carnets can also be generated with the `metadata` attribute, just like in th
 
 There are other optional params:
 
-- `post_office_service`, which tells if the carnet must be sent via post office service (to you or to your clients)
 - `split_items`, identifying if the total value must be splitted among the charges (defaults to `false`)
 - The carnet `instructions`
 
@@ -60,36 +59,6 @@ body = {
 
 The `notification_url` property will be used for sending notifications once things happen with charges statuses, as when it's payment was approved, for example. More about notifications [here](https://github.com/gerencianet/gn-api-sdk-node/tree/master/docs/notifications.md). The `custom_id` property can be used to set your own reference to the carnet.
 
-
-### Required properties plus post office service information **(optional)**:
-
-If you want the carnet to arrive at your house or at your client's house, you can count on Gerencianet's post office service. Just send an extra attribute:
-
-```ruby
-body = {
-  items: [{
-    name: "Carnet Item 1",
-    value: 1000,
-    amount: 2
-  }],
-  customer: {
-    name: "Gorbadoc Oldbuck",
-    email: "oldbuck@gerencianet.com.br",
-    cpf: "04267484171",
-    birth: "1977-01-15",
-    phone_number: "5144916523"
-  },
-  repeats: 4,
-  expire_at: "2020-12-12",
-  post_office_service: {
-    send_to: "customer"
-  }
-}
-```
-
-If `send_to` is set to *customer*, the carnet arrives at you customer's. If it is set to *seller*, just wait for it to arrive at your place!
-
-
 ### split_items attribute **(optional)**
 
 By default, each parcel has the total value of the carnet. If you want to divide the total value among the parcels, change `split_items` property to *true*.

data/docs/charge-payment.md

@@ -138,7 +138,7 @@ For testing purposes, you can go to your application playground in your Gerencia
 
 When in production, it will depend if your project is a web app or a mobile app.
 
-For web apps you should follow this [guide](https://api.gerencianet.com.br/checkout/card). It basically consists of copying/pasting a script tag in your checkout page.
+For web apps you should follow this [guide](https://docs.gerencianet.com.br/#!/charges/checkout/card). It basically consists of copying/pasting a script tag in your checkout page.
 
 For mobile apps you should use this [SDK for Android](https://github.com/gerencianet/gn-api-sdk-android) or this [SDK for iOS](https://github.com/gerencianet/gn-api-sdk-ios).
 

data/docs/charges.md

@@ -53,25 +53,6 @@ body = {
 
 The `notification_url` property will be used for sending notifications once things happen with charges statuses, as when it's payment was approved, for example. More about notifications [here](https://github.com/gerencianet/gn-api-sdk-node/tree/master/docs/notifications.md). The `custom_id` property can be used to set your own reference to the charge.
 
-## Post office service:
-
-If you want the charge to arrive at your house or at your client's house, you can count on Gerencianet's post office service. Just send an extra attribute:
-
-```ruby
-body = {
-  items: [{
-    name: "Product A",
-    value: 1000,
-    amount: 2
-  }],
-  post_office_service: {
-    send_to: "customer"
-  }
-}
-```
-
-If `send_to` is set to *customer*, the charge arrives at you customer's. If it is set to *seller*, just wait for it to arrive at your place. It's awesome!
-
 ### Finally, create the charge:
 
 ```ruby

data/docs/examples/cancel_carnet.rb

@@ -0,0 +1,15 @@
+require "gerencianet"
+require_relative "./credentials"
+
+options = {
+  client_id: CREDENTIALS::CLIENT_ID,
+  client_secret: CREDENTIALS::CLIENT_SECRET,
+  sandbox: true
+}
+
+params = {
+  id: 2363
+}
+
+gerencianet = Gerencianet.new(options)
+puts gerencianet.cancel_carnet(params: params)

data/docs/examples/cancel_parcel.rb

@@ -0,0 +1,16 @@
+require "gerencianet"
+require_relative "./credentials"
+
+options = {
+  client_id: CREDENTIALS::CLIENT_ID,
+  client_secret: CREDENTIALS::CLIENT_SECRET,
+  sandbox: true
+}
+
+params = {
+  id: 2363,
+  parcel: 1
+}
+
+gerencianet = Gerencianet.new(options)
+puts gerencianet.cancel_parcel(params: params)

data/lib/gerencianet/constants.rb

@@ -110,6 +110,14 @@ module Gerencianet
       create_carnet_history: {
         route: "/carnet/:id/history",
         method: "post"
+      },
+      cancel_carnet: {
+        route: "/carnet/:id/cancel",
+        method: "put"
+      },
+      cancel_parcel: {
+        route: "/carnet/:id/parcel/:parcel/cancel",
+        method: "put"
       }
     }
   end

data/lib/gerencianet/version.rb

@@ -1,4 +1,4 @@
 # :nodoc:
 module Gerencianet
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gerencianet
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Francisco Carvalho
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-30 00:00:00.000000000 Z
+date: 2016-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -159,6 +159,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
@@ -171,6 +172,8 @@ files:
 - bin/console
 - bin/setup
 - docs/all-in-one.md
+- docs/carnet-cancel-parcel.md
+- docs/carnet-cancel.md
 - docs/carnet-create-history.md
 - docs/carnet-detailing.md
 - docs/carnet-resend-parcel.md
@@ -186,7 +189,9 @@ files:
 - docs/charges.md
 - docs/examples/.gitignore
 - docs/examples/all_in_one.rb
+- docs/examples/cancel_carnet.rb
 - docs/examples/cancel_charge.rb
+- docs/examples/cancel_parcel.rb
 - docs/examples/cancel_subscription.rb
 - docs/examples/create_billet_payment.rb
 - docs/examples/create_card_payment.rb