gerencianet 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: db0dc12a8bb152c33bb1386d2ead264880cf56c0
+  data.tar.gz: 5e72412e908a0369f4cded139d779bea0159601b
+SHA512:
+  metadata.gz: 076b82eac8e238d2115de2c38254b899fa47d2a15dd8d9cf0bc1b8484189a44b70ca5e73974960f3a130b3e99a19c7be43d5a706845ee111d5f10a5ec40afe76
+  data.tar.gz: 518f72c4a4e0a794bd3c0e7b203dde35d6c1865f45ec0eefa3e7b94affb1906f96b9dd9ba205be9410d5b3e847835e0a354139ed925c11fdff1587b7804ce0ce

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.ruby-gemset
+.ruby-version
+.rspec
+turbulence

data/.rubocop.yml

@@ -0,0 +1,9 @@
+Style/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Style/Encoding:
+  Enabled: true
+  EnforcedStyle: when_needed
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.0
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+gem "coveralls", require: false
+
+# require "pry"
+# Pry.start
+
+# Specify your gem's dependencies in gerencianet.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec, cmd: "rspec" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { "spec" }
+  watch("spec/spec_helper.rb")  { "spec" }
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Gerencianet Pagamentos do Brasil
+
+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,118 @@
+# gn-api-sdk-ruby
+
+> A ruby gem for integration of your backend with the payment services
+provided by [Gerencianet](http://gerencianet.com.br).
+
+[![Build Status](https://travis-ci.org/gerencianet/gn-api-sdk-ruby.svg)](https://travis-ci.org/gerencianet/gn-api-sdk-ruby)
+[![Coverage Status](https://coveralls.io/repos/gerencianet/gn-api-sdk-ruby/badge.svg?branch=master&service=github)](https://coveralls.io/github/gerencianet/gn-api-sdk-ruby?branch=master)
+[![Code Climate](https://codeclimate.com/github/gerencianet/gn-api-sdk-ruby/badges/gpa.svg)](https://codeclimate.com/github/gerencianet/gn-api-sdk-ruby)
+
+: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:
+
+```ruby
+gem 'gerencianet'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+Or install it yourself as:
+
+```bash
+$ gem install gerencianet
+```
+
+## Basic usage
+
+```ruby
+require "gerencianet"
+
+options = {
+  client_id: "client_id",
+  client_secret: "client_secret",
+  sandbox: true
+}
+
+gerencianet = Gerencianet.new(@options)
+
+input = {
+  items: [{
+    name: "Product A",
+    value: 1000,
+    amount: 2
+  }]
+}
+
+response = gerencianet.create_charge(input)
+```
+
+## Tests
+
+To run the tests, just run *rspec*:
+
+```bash
+$ rspec
+```
+
+Or use *guard* to watch files and automatically run *rspec*
+
+```bash
+$ guard -n false -c
+```
+
+## Additional documentation
+
+### Charges
+
+- [Creating charges](https://github.com/gerencianet/gn-api-sdk-ruby/tree/master/docs/charges.md)
+- [Paying a charge](https://github.com/gerencianet/gn-api-sdk-ruby/tree/master/docs/charge-payment.md)
+- [Detailing charges](https://github.com/gerencianet/gn-api-sdk-ruby/tree/master/docs/charge-detailing.md)
+- [Updating informations](https://github.com/gerencianet/gn-api-sdk-ruby/tree/master/docs/charge-update.md)
+
+### Carnets
+
+- [Creating carnets](https://github.com/gerencianet/gn-api-sdk-ruby/tree/master/docs/carnets.md)
+- [Detailing carnets](https://github.com/gerencianet/gn-api-sdk-ruby/tree/master/docs/carnet-detailing.md)
+- [Updating informations](https://github.com/gerencianet/gn-api-sdk-ruby/tree/master/docs/carnet-update.md)
+
+### Subscriptions
+
+- [Creating subscriptions](https://github.com/gerencianet/gn-api-sdk-ruby/tree/master/docs/subscriptions.md)
+- [Paying a subscription](https://github.com/gerencianet/gn-api-sdk-ruby/tree/master/docs/subscription-payment.md)
+- [Detailing subscriptions](https://github.com/gerencianet/gn-api-sdk-ruby/tree/master/docs/subscription-detailing.md)
+- [Updating informations](https://github.com/gerencianet/gn-api-sdk-ruby/tree/master/docs/subscription-update.md)
+
+### Marketplace
+
+- [Creating a marketplace](https://github.com/gerencianet/gn-api-sdk-ruby/tree/master/docs/charge-with-marketplace.md)
+
+### Notifications
+
+- [Getting notifications](https://github.com/gerencianet/gn-api-sdk-ruby/tree/master/docs/notifications.md)
+
+### Payments
+
+- [Getting installments](https://github.com/gerencianet/gn-api-sdk-ruby/tree/master/docs/installments.md)
+
+### All in one
+
+- [Usage](https://github.com/gerencianet/gn-api-sdk-ruby/tree/master/docs/all-in-one.md)
+
+## Changelog
+
+[CHANGELOG](https://github.com/gerencianet/gn-api-sdk-ruby/tree/master/CHANGELOG.md)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/gerencianet/gn-api-sdk-ruby. This project is intended to be a safe, welcoming space for collaboration.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](LICENSE).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gerencianet"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gerencianet.gemspec

@@ -0,0 +1,36 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "gerencianet/version"
+
+files = `git ls-files -z`.split("\x0").reject do |f|
+  f.match(%r{^(test|spec|features)/})
+end
+
+Gem::Specification.new do |spec|
+  spec.name          = "gerencianet"
+  spec.version       = Gerencianet::VERSION
+  spec.authors       = ["Francisco Carvalho"]
+  spec.email         = ["desenvolvedores@gerencianet.com.br"]
+
+  spec.summary       = "Gerencianet API Ruby Gem"
+  spec.description   = "A ruby gem for integration of your backend with the
+                        payment services provided by Gerencianet"
+
+  spec.homepage      = "https://github.com/gerencianet/gn-api-sdk-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = files
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10", ">= 1.10"
+  spec.add_development_dependency "rake", "~> 10.0", ">= 10.0"
+  spec.add_development_dependency "rspec", "~> 3.4.0", ">= 3.4.0"
+  spec.add_development_dependency "guard-rspec", "~> 4.6.4", ">= 4.6.4"
+  spec.add_development_dependency "webmock", "~> 1.22.3", ">= 1.22.3"
+  spec.add_development_dependency "rubocop", "~> 0.35.1", ">= 0.35.1"
+
+  spec.add_runtime_dependency "http", "~> 0.9", ">= 0.9.8"
+end

data/lib/gerencianet.rb

@@ -0,0 +1,9 @@
+require "gerencianet/version"
+require "gerencianet/endpoints"
+
+# Module that just returns an Endpoints instance
+module Gerencianet
+  def self.new(options)
+    Endpoints.new(options)
+  end
+end

data/lib/gerencianet/constants.rb

@@ -0,0 +1,100 @@
+module Gerencianet
+  # Endpoints signatures
+  module Constants
+    URL = {
+      production: "https://api.gerencianet.com.br/v1",
+      sandbox: "https://sandbox.gerencianet.com.br/v1"
+    }
+
+    ENDPOINTS = {
+      authorize: {
+        route: "/authorize",
+        method: "post"
+      },
+      create_charge: {
+        route: "/charge",
+        method: "post"
+      },
+      detail_charge: {
+        route: "/charge/:id",
+        method: "get"
+      },
+      update_charge_metadata: {
+        route: "/charge/:id/metadata",
+        method: "put"
+      },
+      update_billet: {
+        route: "/charge/:id/billet",
+        method: "put"
+      },
+      pay_charge: {
+        route: "/charge/:id/pay",
+        method: "post"
+      },
+      cancel_charge: {
+        route: "/charge/:id/cancel",
+        method: "put"
+      },
+      create_carnet: {
+        route: "/carnet",
+        method: "post"
+      },
+      detail_carnet: {
+        route: "/carnet/:id",
+        method: "get"
+      },
+      update_parcel: {
+        route: "/carnet/:id/parcel/:parcel",
+        method: "put"
+      },
+      update_carnet_metadata: {
+        route: "/carnet/:id/metadata",
+        method: "put"
+      },
+      get_notification: {
+        route: "/notification/:token",
+        method: "get"
+      },
+      get_plans: {
+        route: "/plans",
+        method: "get"
+      },
+      create_plan: {
+        route: "/plan",
+        method: "post"
+      },
+      delete_plan: {
+        route: "/plan/:id",
+        method: "del"
+      },
+      create_subscription: {
+        route: "/plan/:id/subscription",
+        method: "post"
+      },
+      detail_subscription: {
+        route: "/subscription/:id",
+        method: "get"
+      },
+      pay_subscription: {
+        route: "/subscription/:id/pay",
+        method: "post"
+      },
+      cancel_subscription: {
+        route: "/subscription/:id/cancel",
+        method: "put"
+      },
+      update_subscription_metadata: {
+        route: "/subscription/:id/metadata",
+        method: "put"
+      },
+      get_installments: {
+        route: "/installments",
+        method: "get"
+      },
+      resend_billet: {
+        route: "/charge/:id/billet/resend",
+        method: "post"
+      }
+    }
+  end
+end

data/lib/gerencianet/endpoints.rb

@@ -0,0 +1,133 @@
+require "http"
+require "gerencianet/constants"
+require "gerencianet/status"
+
+module Gerencianet
+  # Given the constants file, with the endpoints signatures,
+  # this class maps each one of them to a concerning function
+  class Endpoints
+    attr_accessor :token
+    attr_reader :endpoints
+    attr_reader :urls
+    attr_reader :base_url
+    attr_reader :options
+
+    def initialize(options)
+      @token = nil
+      @options = options
+      @endpoints = Constants::ENDPOINTS
+      @urls = Constants::URL
+      @base_url = current_base_url
+
+      create_methods
+    end
+
+    private
+
+    def create_methods
+      @endpoints.each do |key, settings|
+        self.class.send(:define_method, key) do |params = nil, body = nil|
+          create(params, body, settings)
+        end
+      end
+    end
+
+    def create(params, body, settings)
+      authenticate unless @token
+
+      response = make_request(params, body, settings)
+
+      if response.status.to_s == STATUS::UNAUTHORIZED
+        authenticate
+        response = make_request(params, body, settings)
+      end
+
+      response
+    end
+
+    def make_request(params, body, settings)
+      url = get_url(params, settings[:route])
+
+      HTTP
+        .headers(accept: "application/json")
+        .auth("Bearer #{@token['access_token']}")
+        .method(settings[:method])
+        .call(url, json: body)
+    end
+
+    def authenticate
+      url = get_url({}, @endpoints[:authorize][:route])
+
+      response =
+        HTTP.basic_auth(auth_headers)
+        .post(url, json: auth_body)
+
+      respond(response)
+    end
+
+    def auth_headers
+      {
+        user: @options[:client_id],
+        pass: @options[:client_secret]
+      }
+    end
+
+    def auth_body
+      {grant_type: :client_credentials}
+    end
+
+    def respond(response)
+      if response.status.to_s == STATUS::OK
+        begin
+          @token = JSON.parse(response)
+        rescue JSON::ParserError
+          raise "unable to parse server response, not a valid json"
+        end
+      else
+        fail "unable to authenticate"
+      end
+    end
+
+    def get_url(params, route)
+      params = {} if params.nil?
+      route = remove_placeholders(params, route)
+      full_url(params, route)
+    end
+
+    def remove_placeholders(params, route)
+      regex = /\:(\w+)/
+      route.scan(regex).each do |key|
+        key = key[0]
+        value = params[key.to_sym].to_s
+        route = route.gsub(":#{key}", value)
+        params.delete(key.to_sym)
+      end
+
+      route
+    end
+
+    def full_url(params, route)
+      mapped = map_params(params)
+
+      if !mapped.empty?
+        "#{@base_url}#{route}?#{mapped}"
+      else
+        "#{@base_url}#{route}"
+      end
+    end
+
+    def map_params(params)
+      params.map do |key|
+        "#{key[0]}=#{key[1]}"
+      end.join("&")
+    end
+
+    def current_base_url
+      if @options[:sandbox]
+        @urls[:sandbox]
+      else
+        @urls[:production]
+      end
+    end
+  end
+end

data/lib/gerencianet/status.rb

@@ -0,0 +1,7 @@
+module Gerencianet
+  # HTTP response statuses
+  module STATUS
+    OK = "200 OK"
+    UNAUTHORIZED = "401 Unauthorized"
+  end
+end

data/lib/gerencianet/version.rb

@@ -0,0 +1,4 @@
+# :nodoc:
+module Gerencianet
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,203 @@
+--- !ruby/object:Gem::Specification
+name: gerencianet
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Francisco Carvalho
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.6.4
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.6.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.6.4
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.6.4
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.22.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.22.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.22.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.22.3
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.35.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.35.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.35.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.35.1
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.8
+description: |-
+  A ruby gem for integration of your backend with the
+                          payment services provided by Gerencianet
+email:
+- desenvolvedores@gerencianet.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gerencianet.gemspec
+- lib/gerencianet.rb
+- lib/gerencianet/constants.rb
+- lib/gerencianet/endpoints.rb
+- lib/gerencianet/status.rb
+- lib/gerencianet/version.rb
+homepage: https://github.com/gerencianet/gn-api-sdk-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Gerencianet API Ruby Gem
+test_files: []