charging-client 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b6cea962d86f4464d68fc2deb0e0186c06841ed3
+  data.tar.gz: e46d5202149dde2a7b21e5fe10005bd99a2382e0
+SHA512:
+  metadata.gz: eddae88e436aae2798a89c2117397a319a37256972eb9199c07aca61c92712f3257032a1788a8fe125a7927cfd62b4de7ecc23016beb896b4e252dd19ca425c3
+  data.tar.gz: af6cdded1b2e90457a6ff6cd03cca87db7f4ea6233f145f654596f16f569bd36142d35a9e35cb1a88ec7516ea8770d318469880f8e7889b6dbbeabd7c5aed02b

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.DS_Store
+.ruby-*
+.rvmrc
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.rspec

@@ -0,0 +1,2 @@
+--format progress
+--color

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.1.9
+  - 2.2.5
+  - 2.3.1
+script:
+  - bundle exec rake --trace spec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in passaporteweb-client.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,81 @@
+PATH
+  remote: .
+  specs:
+    charging-client (0.0.2)
+      multi_json (~> 1.11)
+      rest-client (~> 1.6.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.4.0)
+    awesome_print (1.7.0)
+    coderay (1.1.1)
+    coveralls (0.8.13)
+      json (~> 1.8)
+      simplecov (~> 0.11.0)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+      tins (~> 1.6.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    json (1.8.3)
+    method_source (0.8.2)
+    mime-types (1.25.1)
+    multi_json (1.12.1)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-nav (0.2.4)
+      pry (>= 0.9.10, < 0.11.0)
+    rake (10.5.0)
+    rdoc (4.2.2)
+      json (~> 1.4)
+    rest-client (1.6.9)
+      mime-types (~> 1.16)
+    rspec (2.99.0)
+      rspec-core (~> 2.99.0)
+      rspec-expectations (~> 2.99.0)
+      rspec-mocks (~> 2.99.0)
+    rspec-core (2.99.2)
+    rspec-expectations (2.99.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.99.4)
+    safe_yaml (1.0.4)
+    simplecov (0.11.2)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slop (3.6.0)
+    term-ansicolor (1.3.2)
+      tins (~> 1.0)
+    thor (0.19.1)
+    tins (1.6.0)
+    vcr (2.9.3)
+    webmock (1.9.3)
+      addressable (>= 2.2.7)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print (~> 1.1)
+  bundler (> 1.3.2)
+  charging-client!
+  coveralls (~> 0.6)
+  pry (~> 0.9)
+  pry-nav (~> 0.2)
+  rake (~> 10.0)
+  rdoc (~> 4.0)
+  rspec (~> 2.13)
+  simplecov (~> 0.7)
+  vcr (~> 2.4)
+  webmock (~> 1.9.3)
+
+BUNDLED WITH
+   1.12.5

data/LICENSE

@@ -0,0 +1,191 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright
+owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities
+that control, are controlled by, or are under common control with that entity.
+For the purposes of this definition, "control" means (i) the power, direct or
+indirect, to cause the direction or management of such entity, whether by
+contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including
+but not limited to software source code, documentation source, and configuration
+files.
+
+"Object" form shall mean any form resulting from mechanical transformation or
+translation of a Source form, including but not limited to compiled object code,
+generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made
+available under the License, as indicated by a copyright notice that is included
+in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that
+is based on (or derived from) the Work and for which the editorial revisions,
+annotations, elaborations, or other modifications represent, as a whole, an
+original work of authorship. For the purposes of this License, Derivative Works
+shall not include works that remain separable from, or merely link (or bind by
+name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version
+of the Work and any modifications or additions to that Work or Derivative Works
+thereof, that is intentionally submitted to Licensor for inclusion in the Work
+by the copyright owner or by an individual or Legal Entity authorized to submit
+on behalf of the copyright owner. For the purposes of this definition,
+"submitted" means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems, and
+issue tracking systems that are managed by, or on behalf of, the Licensor for
+the purpose of discussing and improving the Work, but excluding communication
+that is conspicuously marked or otherwise designated in writing by the copyright
+owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
+of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+2. Grant of Copyright License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the Work and such
+Derivative Works in Source or Object form.
+
+3. Grant of Patent License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable (except as stated in this section) patent license to make, have
+made, use, offer to sell, sell, import, and otherwise transfer the Work, where
+such license applies only to those patent claims licensable by such Contributor
+that are necessarily infringed by their Contribution(s) alone or by combination
+of their Contribution(s) with the Work to which such Contribution(s) was
+submitted. If You institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work or a
+Contribution incorporated within the Work constitutes direct or contributory
+patent infringement, then any patent licenses granted to You under this License
+for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution.
+
+You may reproduce and distribute copies of the Work or Derivative Works thereof
+in any medium, with or without modifications, and in Source or Object form,
+provided that You meet the following conditions:
+
+You must give any other recipients of the Work or Derivative Works a copy of
+this License; and
+You must cause any modified files to carry prominent notices stating that You
+changed the files; and
+You must retain, in the Source form of any Derivative Works that You distribute,
+all copyright, patent, trademark, and attribution notices from the Source form
+of the Work, excluding those notices that do not pertain to any part of the
+Derivative Works; and
+If the Work includes a "NOTICE" text file as part of its distribution, then any
+Derivative Works that You distribute must include a readable copy of the
+attribution notices contained within such NOTICE file, excluding those notices
+that do not pertain to any part of the Derivative Works, in at least one of the
+following places: within a NOTICE text file distributed as part of the
+Derivative Works; within the Source form or documentation, if provided along
+with the Derivative Works; or, within a display generated by the Derivative
+Works, if and wherever such third-party notices normally appear. The contents of
+the NOTICE file are for informational purposes only and do not modify the
+License. You may add Your own attribution notices within Derivative Works that
+You distribute, alongside or as an addendum to the NOTICE text from the Work,
+provided that such additional attribution notices cannot be construed as
+modifying the License.
+You may add Your own copyright statement to Your modifications and may provide
+additional or different license terms and conditions for use, reproduction, or
+distribution of Your modifications, or for any such Derivative Works as a whole,
+provided Your use, reproduction, and distribution of the Work otherwise complies
+with the conditions stated in this License.
+
+5. Submission of Contributions.
+
+Unless You explicitly state otherwise, any Contribution intentionally submitted
+for inclusion in the Work by You to the Licensor shall be under the terms and
+conditions of this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify the terms of
+any separate license agreement you may have executed with Licensor regarding
+such Contributions.
+
+6. Trademarks.
+
+This License does not grant permission to use the trade names, trademarks,
+service marks, or product names of the Licensor, except as required for
+reasonable and customary use in describing the origin of the Work and
+reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty.
+
+Unless required by applicable law or agreed to in writing, Licensor provides the
+Work (and each Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
+including, without limitation, any warranties or conditions of TITLE,
+NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
+solely responsible for determining the appropriateness of using or
+redistributing the Work and assume any risks associated with Your exercise of
+permissions under this License.
+
+8. Limitation of Liability.
+
+In no event and under no legal theory, whether in tort (including negligence),
+contract, or otherwise, unless required by applicable law (such as deliberate
+and grossly negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special, incidental,
+or consequential damages of any character arising as a result of this License or
+out of the use or inability to use the Work (including but not limited to
+damages for loss of goodwill, work stoppage, computer failure or malfunction, or
+any and all other commercial damages or losses), even if such Contributor has
+been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability.
+
+While redistributing the Work or Derivative Works thereof, You may choose to
+offer, and charge a fee for, acceptance of support, warranty, indemnity, or
+other liability obligations and/or rights consistent with this License. However,
+in accepting such obligations, You may act only on Your own behalf and on Your
+sole responsibility, not on behalf of any other Contributor, and only if You
+agree to indemnify, defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason of your
+accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work
+
+To apply the Apache License to your work, attach the following boilerplate
+notice, with the fields enclosed by brackets "[]" replaced with your own
+identifying information. (Don't include the brackets!) The text should be
+enclosed in the appropriate comment syntax for the file format. We also
+recommend that a file or class name and description of purpose be included on
+the same "printed page" as the copyright notice for easier identification within
+third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.rdoc

@@ -0,0 +1,228 @@
+= charging-client-ruby
+
+A Ruby client for the Charging REST API
+
+{<img src="https://badge.fury.io/rb/charging-client.png" alt="Gem Version" />}[https://rubygems.org/gems/charging-client]
+{<img src="https://travis-ci.org/myfreecomm/charging-client-ruby.png?branch=master" alt="Build Status" />}[https://travis-ci.org/myfreecomm/charging-client-ruby]
+{<img src="https://coveralls.io/repos/myfreecomm/charging-client-ruby/badge.png?branch=master" alt="Coverage Status" />}[https://coveralls.io/r/myfreecomm/charging-client-ruby]
+{<img src="https://codeclimate.com/github/myfreecomm/charging-client-ruby.png" alt="Code Climate Status" />}[https://codeclimate.com/github/myfreecomm/charging-client-ruby]
+
+Charging API docs: ???
+
+charging-client-ruby RDoc documentation: http://rubydoc.info/github/myfreecomm/charging-client-ruby/frames/
+
+The {RDoc}[http://rubydoc.info/github/myfreecomm/charging-client-ruby/frames/] is the best place to learn how to use this client. A few example uses are listed below. See the mapping of API endpoints to this client code below as well to find what you need.
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+  gem 'charging-client', :require => 'charging'
+
+And then execute:
+
+  $ bundle
+
+Or install it yourself as:
+
+  $ gem install charging-client
+
+== Usage
+
+=== Mapping of API endpoints to this client
+
+TODO
+
+=== Configuration
+
+  require "charging"
+  
+  Charging.configure do |c|
+    # You application token at Charging Service
+    # Required
+    c.application_token = 'YourApptoken=='
+    
+    # URL for request data.
+    # Default: 'https://charging.finnanceconnect.com.br'
+    c.url = 'http://sandbox.charging.financeconnect.com.br'
+    
+    # User agent to identify the http request on Charing.
+    # Default: 'Charging Ruby Client v0.0.1'
+    c.user_agent = 'My App v1.0'
+  end
+
+=== Examples
+
+==== Getting info about your service account
+
+  account = Charging::ServiceAccount.current
+  
+  account.name # => 'Your App Name on Charging'
+  
+  account.last_response  # a success RestClient::Response instance
+  account.last_response.code # => 200
+  
+  begin
+    account = Charging::ServiceAccount.current
+  rescue Charging::Http::LastResponseError => exception
+    exception.last_response # an unauthorized RestClient::Response instance
+    exception.last_response.code # 401
+  end
+
+
+==== List domains for an account
+
+  domains = Charging::Domain.find_all(account)
+
+==== Create a new domain
+
+  attributes = {
+    :supplier_name      => 'Myfreecomm',
+    :address            => 'Rua do Carmo, 43',
+    :city_state         => 'Rio de Janeiro/RJ',
+    :zipcode            => '20011-020',
+    national_identifier => '37.818.380/0001-86',
+    description         => 'A Myfreecomm é uma empresa moderna...'
+  }
+  
+  new_domain = Charging::Domain.new(attributes, account)
+  
+  new_domain.persisted? # => false
+  new_domain.create!
+  new_domain.persisted? # => true
+
+==== Find a domain by uuid
+
+  domain = Charging::Domain.find_by_uuid(account, 'supposed-uuid-for-domain')
+  domain.persisted? # => true
+
+==== Update an attribute of a domain (Not working yet)
+
+Pending
+
+=== Update all attributes for a domain (Not working yet)
+
+Pending
+
+==== Delete a domain
+
+  domain.destroy!
+  domain.deleted? # => true
+  domain.persisted? # => false
+
+==== Find a domain by token
+
+  domain = Charging::Domain.find_by_token('domain-token')
+
+==== Create a charge account for a domain
+
+  attributes = {
+    :bank => '237',
+    :name => 'Conta de Cobrança no Bradesco',
+    :agreement_code => '1234',
+    :portifolio_code => '25'
+    :agency => {:number => '1234'},
+    :account => {:number => '12345', :digit => '6'}
+  }
+  new_charge_account = Charging::ChargeAccount.new(attributes, domain)
+  new_charge_account.persisted? # => false
+  new_charge_account.create!
+  new_charge_account.persisted? # => true
+
+==== List charge accounts for current domain
+
+  charge_accountes = ChargeAccount::ChargeAccount.find_all(domain)
+
+==== Find a charge account by uuid
+
+  charge_account = ChargeAccount::ChargeAccount.find_by_uuid(domain, 'supposed-uuid-for-charge-account')
+  charge_account.persisted? # => true
+
+==== List available banks for a charge account (Not working yet)
+
+Pending
+
+==== List currencies for a charge account (Not working yet)
+
+Pending
+
+==== Update an attribute of a charge account
+
+  charge_account.update_attribute! :address, 'Novo Endereço'
+
+==== Update attributes of a charge account
+
+  charge_account.update_attributes! address: 'Novo Endereço', city_state: 'Cidade/UF'
+
+Note: This will execute <tt>charge_account#update_attribute!</tt> for each attribute. If something wrong, updated attributes will not get back old values.
+
+==== Delete a charge account
+
+  charge_account.destroy!
+
+==== Get invoice kinds
+
+  Invoice.kinds(domain) # => [{"acronym"=>"DM", "itau_code"=>1, "code"=>2, "name"=>"Duplicata Mercantil"}, ...]
+  Invoice.kinds(domain)
+
+==== Create an invoice
+
+  attributes = {
+    :kind => 1,
+    :amount => 123.45,
+    :document_number => '123456789012345',
+    :due_date => '2015-12-31'
+    :drawee => {
+      :name => 'Fulano de Tal',
+      :address => 'Rua do Carmo, 43',
+      :city_state => 'Rio de Janeiro/RJ',
+      :zipcode => '20011-020',
+      :national_identifier => '43.055.679/0001-29'
+    }
+  }
+  
+  new_invoice = Charging::Invoice.new(attributes, domain, charge_account)
+  new_invoice.persisted? # => false
+  new_invoice.create!
+  new_invoice.persisted? # => true
+
+==== Find an invoice by uuid
+
+  invoice = Charging::Invoice.find_by_uuid(domain, 'supposed-uuid-for-invoice')
+  invoice.persisted? # => true
+
+==== Get URL to print invoice
+
+  invoice.billet_url # => 'https://charging.financeconnect.com.br/billets/6a60.../ff01.../'
+
+==== Delete an invoice
+
+  invoice.destroy!
+  invoice.deleted? # => true
+  invoice.persisted? # => false
+
+==== Register a payment for an invoice
+
+  invoice.pay!
+  invoice.paid # => invoice.amount
+  invoice.pay!({
+    :amount => invoice.amount, # default
+    :date => Time.now.strftime('%Y-%m-%d'), #default
+    :note => 'some important note about this payment'
+  })
+
+==== List payments for an invoice
+
+  invoice.payments
+
+==== Batches (Not working yet)
+
+Pending
+
+== Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request