billimatic-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9532f216c2df6e26a862a6f2fc69467f71cc3e11
+  data.tar.gz: 4ccc394a07225e14d6771c273817484f5863a1c7
+SHA512:
+  metadata.gz: 878280c8f5ca6466ffb854d401790b6deae8af6b3f4701f2bc0b2325b5239549b230fe1a34a8de12002783219b9a608a648199f3776d8dfd886466b187ba58fe
+  data.tar.gz: a75c209d9530d8bcfa7640680e666003e8b7993bd9782af5ef76b6761be44586fabdd01c53933eb12ce13c176dbe894108b6876c1bdd0d159c1cdb052cd5227e

data/.codeclimate.yml

@@ -0,0 +1,7 @@
+---
+engines:
+  fixme:
+    enabled: true
+ratings:
+  paths: []
+exclude_paths: []

data/.gitignore

@@ -0,0 +1,41 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+.env
+.envrc
+
+.DS_Store

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.1.8
+  - 2.2.4
+  - 2.3.0
+env:
+  global:
+    # CODECLIMATE_REPO_TOKEN
+    - secure: "EQVwKIRe3wcDIVOhHNzXpkGuPeadGezOGgm0HIvXCkx6P8+QYNkTVbFoWWEoiDI388mLbIWqi4TePlYe0/HBkXNOZnyHuTeCn/juWELKVwpNPPQdWCuyQocxyXhfax3FBGNwybNu2wy+jWSGoU789Jhf2oVGgKMgaZfjZyoj/zSszla4bSzUk6RWJH8vu2u0uhjaZtlgz/Z13DpEBxBgOUcpx4AcTHjKKmUFmU6i/q0ZVcc2RW8igZcqgMyMMP2sXQ+GV/BVM7wJfFIKM1/7r6ZHK7cu6rxKdEpEAailHJzUGXfFxMR2xLr9PJxvJx1CumP/9ofHsE1BErL1O+BpsDf0sG+tAFcuXCJB5Twvtd4U9gmlFlsp8WY/aINm5kBDtLaPz1pmJucKRYfwBAWiBMlJzSu3rzM0leNsvgkRUvmoGw3fkurNrPr4QI8XG50+zfQYKXJ0SA8LsGtky2+Gm8MOQ5PkWFtrs+RQCpWHWKHlVNe0Dt6yG/U6PbrrIyTngyfIVob7qwMgTC3m72JiDNw5zTW95d6x2dZDlCYTiRvVoppOHIlo+MrWVRxeYEOH1pT9nZiJx2eH7n1V/HsOdInUyywVhtm/ypUDRqX/Qe5Wx0jQOXxZD3XdqVKQuQcvTA0MsDy3FvnxRKy0s94iv2aL6PeQtySkUKrjsd7gT9k="
+script:
+  - bundle exec rake --trace spec

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,120 @@
+PATH
+  remote: .
+  specs:
+    billimatic-client (0.0.1)
+      multi_json (~> 1.11.2)
+      typhoeus (~> 1.0.1)
+      virtus (~> 1.0.5)
+      wisper (~> 1.6.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    byebug (8.2.4)
+    codeclimate-test-reporter (0.5.0)
+      simplecov (>= 0.7.1, < 1.0.0)
+    coderay (1.1.1)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    equalizer (0.0.11)
+    ethon (0.8.1)
+      ffi (>= 1.3.0)
+    ffi (1.9.10)
+    formatador (0.2.5)
+    guard (2.13.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, <= 4.0)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.6.5)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    ice_nine (0.11.2)
+    json (1.8.3)
+    listen (3.0.6)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9.7)
+    lumberjack (1.0.10)
+    method_source (0.8.2)
+    multi_json (1.11.2)
+    nenv (0.3.0)
+    notiffany (0.0.8)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    notifier (0.5.1)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (3.3.0)
+      byebug (~> 8.0)
+      pry (~> 0.10)
+    rake (11.1.2)
+    rb-fsevent (0.9.7)
+    rb-inotify (0.9.7)
+      ffi (>= 0.5.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    shellany (0.0.1)
+    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)
+    test_notifier (2.0.3)
+      notifier
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    typhoeus (1.0.1)
+      ethon (>= 0.8.0)
+    vcr (3.0.1)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+    wisper (1.6.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  billimatic-client!
+  bundler (~> 1.11)
+  codeclimate-test-reporter (~> 0.5)
+  guard-rspec (~> 4.6)
+  pry-byebug (~> 3.3)
+  rake (~> 11.1)
+  rspec (~> 3.4)
+  simplecov (~> 0.11)
+  test_notifier (~> 2.0)
+  vcr (~> 3.0)
+
+BUNDLED WITH
+   1.11.2

data/Guardfile

@@ -0,0 +1,70 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # # Rails files
+  # rails = dsl.rails(view_extensions: %w(erb haml slim))
+  # dsl.watch_spec_files_for(rails.app_files)
+  # dsl.watch_spec_files_for(rails.views)
+
+  # watch(rails.controllers) do |m|
+  #   [
+  #     rspec.spec.("routing/#{m[1]}_routing"),
+  #     rspec.spec.("controllers/#{m[1]}_controller"),
+  #     rspec.spec.("acceptance/#{m[1]}")
+  #   ]
+  # end
+
+  # # Rails config changes
+  # watch(rails.spec_helper)     { rspec.spec_dir }
+  # watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  # watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # # Capybara features specs
+  # watch(rails.view_dirs)     { |m| rspec.spec.("features/#{m[1]}") }
+  # watch(rails.layouts)       { |m| rspec.spec.("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Myfreecomm
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,184 @@
+# Billimatic API Ruby Client
+
+This is the official Ruby client for the [Billimatic](http://www.billimatic.com.br) API.
+
+[![Gem Version](https://badge.fury.io/rb/billimatic-client.png)](https://rubygems.org/gems/billimatic-client)
+[![Build Status](https://api.travis-ci.org/myfreecomm/billimatic-client-ruby.svg?branch=master)](https://travis-ci.org/myfreecomm/billimatic-client-ruby)
+[![Test Coverage](https://codeclimate.com/github/myfreecomm/billimatic-client-ruby/badges/coverage.svg)](https://codeclimate.com/github/myfreecomm/billimatic-client-ruby/coverage)
+[![Code Climate Grade](https://codeclimate.com/github/myfreecomm/billimatic-client-ruby/badges/gpa.svg)](https://codeclimate.com/github/myfreecomm/billimatic-client-ruby)
+[![Inline docs](http://inch-ci.org/github/myfreecomm/billimatic-client-ruby.svg?branch=master)](http://inch-ci.org/github/myfreecomm/billimatic-client-ruby)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'billimatic-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install billimatic-client
+
+## Configuration
+
+##### Use Billimatic.configure to setup your environment:
+
+```ruby
+require 'billimatic'
+
+Billimatic.configure do |config|
+  config.url = 'https://sandbox.billimatic.com.br/api/v1' # defaults to 'https://app.billimatic.com.br/api/v1'
+  config.user_agent = 'My App v1.0' # optional, but you should pass a custom user-agent identifying your app
+end
+```
+
+## Usage
+
+##### Given your token, create an instance of Billimatic::Client, as below:
+
+```ruby
+client = Billimatic.client("YOUR_TOKEN_HERE")
+```
+
+##### Now you have acess to every API endpoint:
+
+* [Companies API](https://app.billimatic.com.br/docs/api#!/companies) as `client.companies`
+* [Plans API](https://app.billimatic.com.br/docs/api#!/plans) as `client.plans`
+* [Subscriptions API](https://app.billimatic.com.br/docs/api#!/subscriptions) as `client.subscriptions`
+
+## Endpoints
+
+#### [Companies](https://app.billimatic.com.br/docs/api#!/companies)
+
+<table>
+    <tr>
+        <th>HTTP method</th>
+        <th>Endpoint</th>
+        <th>Client method</th>
+    </tr>
+    <tr>
+        <td><code>GET</code></td>
+        <td>
+            <a href="https://app.billimatic.com.br/docs/api#!/companies/API_V1_Companies_search_get_0" target="_blank">
+                /api/v1/companies/search?cnpj=:cnpj
+            </a>
+        </td>
+        <td>
+            <code>client.companies.search(cnpj)</code>
+        </td>
+    </tr>
+    <tr>
+        <td><code>POST</code></td>
+        <td>
+            <a href="https://app.billimatic.com.br/docs/api#!/companies/API_V1_Companies_create_post_1" target="_blank">
+                /api/v1/companies
+            </a>
+        </td>
+        <td>
+            <code>client.companies.create(attributes_hash)</code>
+        </td>
+    </tr>
+    <tr>
+        <td><code>PATCH</code></td>
+        <td>
+            <a href="https://app.billimatic.com.br/docs/api#!/companies/API_V1_Companies_update_patch_2" target="_blank">
+                /api/v1/companies/:id
+            </a>
+        </td>
+        <td>
+            <code>client.companies.update(id, attributes_hash)</code>
+        </td>
+    </tr>
+    <tr>
+        <td><code>DELETE</code></td>
+        <td>
+            <a href="https://app.billimatic.com.br/docs/api#!/companies/API_V1_Companies_destroy_delete_3" target="_blank">
+                /api/v1/companies/:id
+            </a>
+        </td>
+        <td>
+            <code>client.companies.destroy(id)</code>
+        </td>
+    </tr>
+</table>
+
+#### [Plans](https://app.billimatic.com.br/docs/api#!/plans)
+
+<table>
+    <tr>
+        <th>HTTP method</th>
+        <th>Endpoint</th>
+        <th>Client method</th>
+    </tr>
+    <tr>
+        <td><code>GET</code></td>
+        <td>
+            <a href="https://app.billimatic.com.br/docs/api#!/plans/API_V1_Plans_index_get_0" target="_blank">
+                /api/v1/organizations/:organization_id/plans
+            </a>
+        </td>
+        <td>
+            <code>client.plans.list(organization_id: id)</code>
+        </td>
+    </tr>
+</table>
+
+#### [Subscriptions](https://app.billimatic.com.br/docs/api#!/subscriptions)
+
+<table>
+    <tr>
+        <th>HTTP method</th>
+        <th>Endpoint</th>
+        <th>Client method</th>
+    </tr>
+    <tr>
+        <td><code>GET</code></td>
+        <td>
+            <a href="https://app.billimatic.com.br/docs/api#!/subscriptions/API_V1_Subscriptions_show_by_token_get_1" target="_blank">
+                /api/v1/subscriptions/token/:token
+            </a>
+        </td>
+        <td>
+            <code>client.subscriptions.show(token: token)</code>
+        </td>
+    </tr>
+    <tr>
+        <td><code>POST</code></td>
+        <td>
+            <a href="https://app.billimatic.com.br/docs/api#!/subscriptions/API_V1_Subscriptions_create_post_2" target="_blank">
+                /api/v1/subscriptions
+            </a>
+        </td>
+        <td>
+            <code>client.subscriptions.create(attributes_hash)</code>
+        </td>
+    </tr>
+    <tr>
+        <td><code>PATCH</code></td>
+        <td>
+            <a href="https://app.billimatic.com.br/docs/api#!/subscriptions/API_V1_Subscriptions_cancel_patch_0" target="_blank">
+                /api/v1/subscriptions/:token/cancel
+            </a>
+        </td>
+        <td>
+            <code>client.subscriptions.cancel(token: token)</code>
+        </td>
+    </tr>
+</table>
+
+## Callbacks
+
+TODO
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/billimatic-client-ruby/fork )
+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 a new Pull Request