bb_oauth 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fa5ea64a3df6396d2d374e5fff681853b9b73daa0bde345e3dd042c913390c52
+  data.tar.gz: 5fbe500346f036209908fa4a99444eeaf0498439f91ae7933c0117d1ca92641c
+SHA512:
+  metadata.gz: 9d187df2297d901c5f6ac70efdd466564e2683bdc412349cfff6157616f83ebedc7b29306c01694eecc8fdb3c7655b88bb35c7795da58a334b91fefd19a615ef
+  data.tar.gz: 47057b7ce7b7ea847a76edf914bfadf38e82f607e6e4c31dda16f6a74829bba2ca334c0e11f9a9b23ebf6f62363c0ba041f12fab70c2ff1dcd01c95122031e18

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/Gemfile.lock

@@ -0,0 +1,71 @@
+PATH
+  remote: .
+  specs:
+    bb_oauth (1.0.1)
+      json (~> 2.1, >= 2.1.0)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    ethon (0.16.0)
+      ffi (>= 1.15.0)
+    ffi (1.15.5)
+    jaro_winkler (1.5.4)
+    json (2.6.3)
+    method_source (1.0.0)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    psych (3.3.0)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (0.66.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    ruby-progressbar (1.11.0)
+    typhoeus (1.4.0)
+      ethon (>= 0.9.0)
+    unicode-display_width (1.5.0)
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  bb_oauth!
+  pry-byebug
+  rake (~> 13.0.1)
+  rspec (~> 3.6, >= 3.6.0)
+  rubocop (~> 0.66.0)
+
+BUNDLED WITH
+   2.2.0

data/README.md

@@ -0,0 +1,85 @@
+# bb_oauth
+
+Unofficial Banco do Brasil OAuth Gem 
+
+BancoBrasilClientCredentials - the Ruby gem for the Fluxo Client Credentials
+
+- API version: 1.0.0
+- Package version: 1.0.0
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build bb_oauth.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./bb_oauth-1.0.0.gem
+```
+(for development, run `gem install --dev ./bb_oauth-1.0.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'bb_oauth', '~> 1.0.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'bb_oauth', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+```ruby
+# Load the gem
+require 'bb_oauth'
+
+api_instance = BancoBrasilClientCredentials::DefaultApi.new
+grant_type = 'grant_type_example' # String | 
+scope = 'scope_example' # String | 
+authorization = 'authorization_example' # String | Deverá ser informado no padrão: Basic {Base64(client_id:client_secret)}
+content_type = 'content_type_example' # String | Deverá ser informado:  application/x-www-form-urlencoded 
+
+
+begin
+  result = api_instance.oauth_token_post(grant_type, scope, authorization, content_type)
+  p result
+rescue BancoBrasilClientCredentials::ApiError => e
+  puts "Exception when calling DefaultApi->oauth_token_post: #{e}"
+end
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://oauth.bb.com.br/*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*BancoBrasilClientCredentials::DefaultApi* | [**oauth_token_post**](docs/DefaultApi.md#oauth_token_post) | **POST** /oauth/token | 
+
+## Documentation for Models
+
+ - [BancoBrasilClientCredentials::Body](docs/Body.md)
+ - [BancoBrasilClientCredentials::ResponseToken](docs/ResponseToken.md)
+
+## Documentation for Authorization
+
+ All endpoints do not require authorization.
+

data/Rakefile

@@ -0,0 +1,8 @@
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/bb_oauth.gemspec

@@ -0,0 +1,26 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "bb_oauth/version"
+
+Gem::Specification.new do |s|
+  s.name        = "bb_oauth"
+  s.version     = BancoBrasilClientCredentials::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.homepage    = "https://github.com/ruby-banco-brasil/bb-oauth"
+  s.metadata    = { "source_code_uri" => "https://github.com/ruby-banco-brasil/bb-oauth" }
+  s.authors     = ["Rafael R. Aschoff"]
+  s.email       = ["roque.rafael@gmail.com"]
+  s.summary     = "A ruby wrapper for Banco do Brasil OAuth Client Credentials"
+  s.description = "This gem maps to the BB Client Credentials"
+  s.license     = "Unlicense"
+  s.required_ruby_version = ">= 1.9"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/config.json

@@ -0,0 +1,9 @@
+{
+  "gemName" : "bb_oauth",
+  "moduleName" :  "BancoBrasilClientCredentials",
+  "gemHomepage" : "https://github.com/ruby-banco-brasil/bb-oauth",
+  "gemSummary" : "A ruby wrapper for Banco do Brasil OAuth Client Credentials",
+  "gemDescription": "This gem maps to the BB Client Credentials",
+  "gemAuthor" : "Rafael R. Aschoff",
+  "gemAuthorEmail" : "roque.rafael@gmail.com"
+}

data/docs/Body.md

@@ -0,0 +1,8 @@
+# BancoBrasilClientCredentials::Body
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**grant_type** | **String** | Deverá ser informado: client_credentials | 
+**scope** | **String** | Os escopos deverão ser informados separados por espaço. | 
+

data/docs/DefaultApi.md

@@ -0,0 +1,57 @@
+# BancoBrasilClientCredentials::DefaultApi
+
+All URIs are relative to *https://oauth.bb.com.br/*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**oauth_token_post**](DefaultApi.md#oauth_token_post) | **POST** /oauth/token | 
+
+# **oauth_token_post**
+> ResponseToken oauth_token_post(grant_typescopeauthorizationcontent_type)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'bb_oauth'
+
+api_instance = BancoBrasilClientCredentials::DefaultApi.new
+grant_type = 'grant_type_example' # String | 
+scope = 'scope_example' # String | 
+authorization = 'authorization_example' # String | Deverá ser informado no padrão: Basic {Base64(client_id:client_secret)}
+content_type = 'content_type_example' # String | Deverá ser informado:  application/x-www-form-urlencoded 
+
+
+begin
+  result = api_instance.oauth_token_post(grant_typescopeauthorizationcontent_type)
+  p result
+rescue BancoBrasilClientCredentials::ApiError => e
+  puts "Exception when calling DefaultApi->oauth_token_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **grant_type** | **String**|  | 
+ **scope** | **String**|  | 
+ **authorization** | **String**| Deverá ser informado no padrão: Basic {Base64(client_id:client_secret)} | 
+ **content_type** | **String**| Deverá ser informado:  application/x-www-form-urlencoded  | 
+
+### Return type
+
+[**ResponseToken**](ResponseToken.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/x-www-form-urlencoded
+ - **Accept**: application/x-www-form-urlencoded
+
+
+

data/docs/ResponseToken.md

@@ -0,0 +1,9 @@
+# BancoBrasilClientCredentials::ResponseToken
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**access_token** | **Object** | Token de Acesso | 
+**token_type** | **Object** | Tipo de token | 
+**expires_in** | **Object** | Tempo de Expiração do token | 
+

data/lib/bb_oauth/api/default_api.rb

@@ -0,0 +1,85 @@
+module BancoBrasilClientCredentials
+  class DefaultApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # @param grant_type
+    # @param scope
+    # @param authorization Deverá ser informado no padrão: Basic {Base64(client_id:client_secret)}
+    # @param content_type Deverá ser informado:  application/x-www-form-urlencoded
+    # @param [Hash] opts the optional parameters
+    # @return [ResponseToken]
+    def oauth_token_post(grant_type, scope, authorization, content_type, opts = {})
+      data, _status_code, _headers = oauth_token_post_with_http_info(grant_type, scope, authorization, content_type, opts)
+      data
+    end
+
+    # @param grant_type
+    # @param scope
+    # @param authorization Deverá ser informado no padrão: Basic {Base64(client_id:client_secret)}
+    # @param content_type Deverá ser informado:  application/x-www-form-urlencoded
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ResponseToken, Integer, Hash)>] ResponseToken data, response status code and response headers
+    def oauth_token_post_with_http_info(grant_type, scope, authorization, content_type, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.oauth_token_post ...'
+      end
+      # verify the required parameter 'grant_type' is set
+      if @api_client.config.client_side_validation && grant_type.nil?
+        fail ArgumentError, "Missing the required parameter 'grant_type' when calling DefaultApi.oauth_token_post"
+      end
+      # verify the required parameter 'scope' is set
+      if @api_client.config.client_side_validation && scope.nil?
+        fail ArgumentError, "Missing the required parameter 'scope' when calling DefaultApi.oauth_token_post"
+      end
+      # verify the required parameter 'authorization' is set
+      if @api_client.config.client_side_validation && authorization.nil?
+        fail ArgumentError, "Missing the required parameter 'authorization' when calling DefaultApi.oauth_token_post"
+      end
+      # verify the required parameter 'content_type' is set
+      if @api_client.config.client_side_validation && content_type.nil?
+        fail ArgumentError, "Missing the required parameter 'content_type' when calling DefaultApi.oauth_token_post"
+      end
+      # resource path
+      local_var_path = '/oauth/token'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      # header_params['Accept'] = @api_client.select_header_accept(['application/x-www-form-urlencoded'])
+      # HTTP header 'Content-Type'
+      # header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
+      header_params['Authorization'] = authorization
+      header_params['Content-Type'] = content_type
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      form_params['grant_type'] = grant_type
+      form_params['scope'] = scope
+
+      # http body (model)
+      post_body = opts[:body]
+
+      return_type = opts[:return_type] || 'ResponseToken'
+
+      auth_names = opts[:auth_names] || []
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type)
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#oauth_token_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end