bb_oauth 1.0.1

data/lib/bb_oauth/models/base_model.rb

@@ -0,0 +1,174 @@
+require 'date'
+
+module BancoBrasilClientCredentials
+  class BaseModel
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      unless attributes.is_a?(Hash)
+        fail ArgumentError, "The input argument (attributes) must be a hash in `#{self.class.name}` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        unless self.class.attribute_map.key?(k.to_sym)
+          fail ArgumentError, "`#{k}` is not a valid attribute in `#{self.class.name}`."\
+                              ' Please check the name to make sure it\'s valid. List of attributes: '\
+                              "#{self.class.attribute_map.keys.inspect}"
+        end
+        h[k.to_sym] = v
+      }
+
+      attributes.each { |key, value| self.send("#{key}=", value) }
+    end
+
+    def list_invalid_properties
+      Array.new
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      list_invalid_properties.empty?
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param o [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+
+      self.class == o.class && self.class.attribute_map.keys.all? { |attr| self.send(attr) == o.send(attr) }
+    end
+
+    # @see the `==` method
+    # @param o [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      self.class.attribute_map.keys.map { |attr| self.send(attr) }.hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param type [String] Data type
+    # @param value [String] Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :NumberDate
+        Date.strptime(value.to_s.rjust(8, '0'), '%d%m%Y')
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        value.to_s =~ /\A(true|t|yes|y|1)\z/i
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        BancoBrasilClientCredentials.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end

data/lib/bb_oauth/models/body.rb

@@ -0,0 +1,36 @@
+require 'date'
+
+module BancoBrasilClientCredentials
+  class Body < BaseModel
+    # Deverá ser informado: client_credentials
+    attr_accessor :grant_type
+
+    # Os escopos deverão ser informados separados por espaço.
+    attr_accessor :scope
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      { grant_type: :grant_type, scope: :scope }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      { grant_type: :Object, scope: :Object }
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @grant_type.nil?
+        invalid_properties.push('invalid value for "grant_type", grant_type cannot be nil.')
+      end
+
+      if @scope.nil?
+        invalid_properties.push('invalid value for "scope", scope cannot be nil.')
+      end
+
+      invalid_properties
+    end
+  end
+end

data/lib/bb_oauth/models/response_token.rb

@@ -0,0 +1,43 @@
+require 'date'
+
+module BancoBrasilClientCredentials
+  class ResponseToken < BaseModel
+    # Token de Acesso
+    attr_accessor :access_token
+
+    # Tipo de token
+    attr_accessor :token_type
+
+    # Tempo de Expiração do token
+    attr_accessor :expires_in
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      { access_token: :access_token, token_type: :token_type, expires_in: :expires_in }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      { access_token: :Object, token_type: :Object, expires_in: :Object }
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @access_token.nil?
+        invalid_properties.push('invalid value for "access_token", access_token cannot be nil.')
+      end
+
+      if @token_type.nil?
+        invalid_properties.push('invalid value for "token_type", token_type cannot be nil.')
+      end
+
+      if @expires_in.nil?
+        invalid_properties.push('invalid value for "expires_in", expires_in cannot be nil.')
+      end
+
+      invalid_properties
+    end
+  end
+end

data/lib/bb_oauth/version.rb

@@ -0,0 +1,3 @@
+module BancoBrasilClientCredentials
+  VERSION = '1.0.1'
+end

data/lib/bb_oauth.rb

@@ -0,0 +1,31 @@
+# Common files
+require 'bb_oauth/api_client'
+require 'bb_oauth/api_error'
+require 'bb_oauth/version'
+require 'bb_oauth/configuration'
+
+# Models
+require 'bb_oauth/models/base_model'
+require 'bb_oauth/models/body'
+require 'bb_oauth/models/response_token'
+
+# APIs
+require 'bb_oauth/api/default_api'
+
+module BancoBrasilClientCredentials
+  class << self
+    # Customize default settings for the SDK using block.
+    #   BancoBrasilClientCredentials.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/spec/api/default_api_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+require 'json'
+
+describe 'DefaultApi' do
+  before { @instance = BancoBrasilClientCredentials::DefaultApi.new }
+
+  describe 'test an instance of DefaultApi' do
+    it 'should create an instance of DefaultApi' do
+      expect(@instance).to be_instance_of(BancoBrasilClientCredentials::DefaultApi)
+    end
+  end
+end

data/spec/api_client_spec.rb

@@ -0,0 +1,201 @@
+require 'spec_helper'
+
+describe BancoBrasilClientCredentials::ApiClient do
+  context 'initialization' do
+    context 'URL stuff' do
+      context 'host' do
+        it 'removes http from host' do
+          BancoBrasilClientCredentials.configure { |c| c.host = 'http://example.com' }
+          expect(BancoBrasilClientCredentials::Configuration.default.host).to eq('example.com')
+        end
+
+        it 'removes https from host' do
+          BancoBrasilClientCredentials.configure { |c| c.host = 'https://wookiee.com' }
+          expect(BancoBrasilClientCredentials::ApiClient.default.config.host).to eq('wookiee.com')
+        end
+
+        it 'removes trailing path from host' do
+          BancoBrasilClientCredentials.configure { |c| c.host = 'hobo.com/v4' }
+          expect(BancoBrasilClientCredentials::Configuration.default.host).to eq('hobo.com')
+        end
+      end
+
+      context 'base_path' do
+        it "prepends a slash to base_path" do
+          BancoBrasilClientCredentials.configure { |c| c.base_path = 'v4/dog' }
+          expect(BancoBrasilClientCredentials::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "doesn't prepend a slash if one is already there" do
+          BancoBrasilClientCredentials.configure { |c| c.base_path = '/v4/dog' }
+          expect(BancoBrasilClientCredentials::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "ends up as a blank string if nil" do
+          BancoBrasilClientCredentials.configure { |c| c.base_path = nil }
+          expect(BancoBrasilClientCredentials::Configuration.default.base_path).to eq('')
+        end
+      end
+    end
+  end
+
+  describe 'params_encoding in #build_request' do
+    let(:config) { BancoBrasilClientCredentials::Configuration.new }
+    let(:api_client) { BancoBrasilClientCredentials::ApiClient.new(config) }
+
+    it 'defaults to nil' do
+      expect(BancoBrasilClientCredentials::Configuration.default.params_encoding).to eq(nil)
+      expect(config.params_encoding).to eq(nil)
+
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:params_encoding]).to eq(nil)
+    end
+
+    it 'can be customized' do
+      config.params_encoding = :multi
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:params_encoding]).to eq(:multi)
+    end
+  end
+
+  describe 'timeout in #build_request' do
+    let(:config) { BancoBrasilClientCredentials::Configuration.new }
+    let(:api_client) { BancoBrasilClientCredentials::ApiClient.new(config) }
+
+    it 'defaults to 0' do
+      expect(BancoBrasilClientCredentials::Configuration.default.timeout).to eq(0)
+      expect(config.timeout).to eq(0)
+
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:timeout]).to eq(0)
+    end
+
+    it 'can be customized' do
+      config.timeout = 100
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:timeout]).to eq(100)
+    end
+  end
+
+  describe '#deserialize' do
+    it "handles Array<Integer>" do
+      api_client = BancoBrasilClientCredentials::ApiClient.new
+      headers = { 'Content-Type' => 'application/json' }
+      response = double('response', headers: headers, body: '[12, 34]')
+      data = api_client.deserialize(response, 'Array<Integer>')
+      expect(data).to be_instance_of(Array)
+      expect(data).to eq([12, 34])
+    end
+
+    it 'handles Array<Array<Integer>>' do
+      api_client = BancoBrasilClientCredentials::ApiClient.new
+      headers = { 'Content-Type' => 'application/json' }
+      response = double('response', headers: headers, body: '[[12, 34], [56]]')
+      data = api_client.deserialize(response, 'Array<Array<Integer>>')
+      expect(data).to be_instance_of(Array)
+      expect(data).to eq([[12, 34], [56]])
+    end
+
+    it 'handles Hash<String, String>' do
+      api_client = BancoBrasilClientCredentials::ApiClient.new
+      headers = { 'Content-Type' => 'application/json' }
+      response = double('response', headers: headers, body: '{"message": "Hello"}')
+      data = api_client.deserialize(response, 'Hash<String, String>')
+      expect(data).to be_instance_of(Hash)
+      expect(data).to eq(:message => 'Hello')
+    end
+  end
+
+  describe '#build_collection_param' do
+    let(:param) { ['aa', 'bb', 'cc'] }
+    let(:api_client) { BancoBrasilClientCredentials::ApiClient.new }
+
+    it 'works for csv' do
+      expect(api_client.build_collection_param(param, :csv)).to eq('aa,bb,cc')
+    end
+
+    it 'works for ssv' do
+      expect(api_client.build_collection_param(param, :ssv)).to eq('aa bb cc')
+    end
+
+    it 'works for tsv' do
+      expect(api_client.build_collection_param(param, :tsv)).to eq("aa\tbb\tcc")
+    end
+
+    it 'works for pipes' do
+      expect(api_client.build_collection_param(param, :pipes)).to eq('aa|bb|cc')
+    end
+
+    it 'works for multi' do
+      expect(api_client.build_collection_param(param, :multi)).to eq(['aa', 'bb', 'cc'])
+    end
+
+    it 'fails for invalid collection format' do
+      expect(proc { api_client.build_collection_param(param, :INVALID) }).to raise_error(RuntimeError, 'unknown collection format: :INVALID')
+    end
+  end
+
+  describe '#json_mime?' do
+    let(:api_client) { BancoBrasilClientCredentials::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.json_mime?(nil)).to eq false
+      expect(api_client.json_mime?('')).to eq false
+
+      expect(api_client.json_mime?('application/json')).to eq true
+      expect(api_client.json_mime?('application/json; charset=UTF8')).to eq true
+      expect(api_client.json_mime?('APPLICATION/JSON')).to eq true
+
+      expect(api_client.json_mime?('application/xml')).to eq false
+      expect(api_client.json_mime?('text/plain')).to eq false
+      expect(api_client.json_mime?('application/jsonp')).to eq false
+    end
+  end
+
+  describe '#select_header_accept' do
+    let(:api_client) { BancoBrasilClientCredentials::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.select_header_accept(nil)).to be_nil
+      expect(api_client.select_header_accept([])).to be_nil
+
+      expect(api_client.select_header_accept(['application/json'])).to eq('application/json')
+      expect(api_client.select_header_accept(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8')
+      expect(api_client.select_header_accept(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON')
+
+      expect(api_client.select_header_accept(['application/xml'])).to eq('application/xml')
+      expect(api_client.select_header_accept(['text/html', 'application/xml'])).to eq('text/html,application/xml')
+    end
+  end
+
+  describe '#select_header_content_type' do
+    let(:api_client) { BancoBrasilClientCredentials::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.select_header_content_type(nil)).to eq('application/json')
+      expect(api_client.select_header_content_type([])).to eq('application/json')
+
+      expect(api_client.select_header_content_type(['application/json'])).to eq('application/json')
+      expect(api_client.select_header_content_type(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8')
+      expect(api_client.select_header_content_type(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON')
+      expect(api_client.select_header_content_type(['application/xml'])).to eq('application/xml')
+      expect(api_client.select_header_content_type(['text/plain', 'application/xml'])).to eq('text/plain')
+    end
+  end
+
+  describe '#sanitize_filename' do
+    let(:api_client) { BancoBrasilClientCredentials::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.sanitize_filename('sun')).to eq('sun')
+      expect(api_client.sanitize_filename('sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('../sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('/var/tmp/sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('./sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('..\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('\var\tmp\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('c:\var\tmp\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('.\sun.gif')).to eq('sun.gif')
+    end
+  end
+end

data/spec/models/body_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+require 'json'
+require 'date'
+
+describe 'Body' do
+  before { @instance = BancoBrasilClientCredentials::Body.new }
+
+  describe 'test an instance of Body' do
+    it 'should create an instance of Body' do
+      expect(@instance).to be_instance_of(BancoBrasilClientCredentials::Body)
+    end
+  end
+end

data/spec/models/response_token_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+require 'json'
+require 'date'
+
+
+describe 'ResponseToken' do
+  before { @instance = BancoBrasilClientCredentials::ResponseToken.new }
+
+  describe 'test an instance of ResponseToken' do
+    it 'should create an instance of ResponseToken' do
+      expect(@instance).to be_instance_of(BancoBrasilClientCredentials::ResponseToken)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+# load the gem
+require 'bb_oauth'
+
+RSpec.configure do |config|
+
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end

data/swagger_oauth_client_credentials.json

@@ -0,0 +1,93 @@
+{
+  "swagger": "2.0",
+  "info": {
+    "title": "Fluxo Client Credentials",
+    "version": "1.0.0"
+  },
+  "host": "oauth.bb.com.br",
+  "schemes": [
+    "https"
+  ],
+  "consumes": [
+    "application/x-www-form-urlencoded"
+  ],
+  "produces": [
+    "application/x-www-form-urlencoded"
+  ],
+  "paths": {
+    "/oauth/token": {
+      "post": {
+        "parameters": [
+          {
+            "name": "grant_type",
+            "description": "Deverá ser informado: client_credentials",
+            "in": "formData",
+            "required": true,
+            "type": "string"
+          },
+          {
+            "name": "scope",
+            "description": "Os escopos deverão ser informados separados por espaço.",
+            "in": "formData",
+            "required": true,
+            "type": "string"
+          },
+          {
+            "name": "Content-Type",
+            "description": "Deverá ser informado:  application/x-www-form-urlencoded\n",
+            "in": "header",
+            "required": true,
+            "type": "string"
+          }
+        ],
+        "responses": {
+          "200": {
+            "schema": {
+              "$ref": "#/definitions/ResponseToken"
+            },
+            "description": "Geração de Access Token"
+          }
+        }
+      },
+      "parameters": [
+        {
+          "name": "Authorization",
+          "description": "Deverá ser informado no padrão: Basic {Base64(client_id:client_secret)}",
+          "in": "header",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "name": "Content-Type",
+          "description": "Deverá ser informado:  application/x-www-form-urlencoded\n",
+          "in": "header",
+          "required": true,
+          "type": "string"
+        }
+      ]
+    }
+  },
+  "definitions": {
+    "ResponseToken": {
+      "description": "",
+      "required": [
+        "access_token",
+        "token_type",
+        "expires_in"
+      ],
+      "type": "object",
+      "properties": {
+        "access_token": {
+          "description": "Token de Acesso"
+        },
+        "token_type": {
+          "description": "Tipo de token"
+        },
+        "expires_in": {
+          "description": "Tempo de Expiração do token"
+        }
+      },
+      "example": "{\n  \"access_token\": \"Yyr_4-0c2bgPhzbH60SkEmMuJO77DI9ZESN-vZBZ_hMK8BNMOAvlw.6en65sKd2itKfRwqKEr\n                   7nZPbT6C4S6AglgqDtDwaUsBgHlbLFzjgZevTxnyv1Zjh0SZQNMTngzw1E60vJkPSJQXWOam2\n                   EylIQ_-j7lOfWjLiLX6zdBF-4BC_9r2IqA5EQhKS\\eZxkN17FcPTwaOpzsOb6tMxvmg6hWVpx\n                   YKMoye64go1VOtPZprBEnjdu3xZIhDFYWcKSfaGJDpcvNXczSQZoK7i19FZetvDa-QX9AO1NK\n                   SQVQXSj-uSK3OnwUQXZySBotR5B_IklGV5oyguUN7ZA3wUMZohhhMTRh9CavKEEG1sf1L8Ygk\n                   vTpTVQv7W9xKhCzqm8Oyy25JrmOaeeI0BYVREc83BitfNKAp3Gf-7mfS6YOit8LWbdfJxxrRA\n                   AIRGhRmCDjahPd_fiRMR4nr-lDi0LHtmlKWVWeswFKdOj1uKsJ8adqL18ksdKfZBJWXh0XFb4\n                   EALjmojkE6t0L_7zrwdNySonkqKotGVwbm3n5j5Eyleqc2O7J11Y2bljHbdLWk7vtUpHmhGEL\n                   zjK-N66iLIhDKZmQEZKILBskWCq5jeSC-ZfF1dkJML-4Jl3nB1DtbyKVlB6Sv65_kJ-qNOCfT\n                   aiifV03VcFvx6cM5qKFozintpvxq8ht8M0M.fxPC5LQXbBSE9WNnHVBGY1qKfGDodeLNI4-qg\n                   4jP5hLKIfLGzOo43zmqiABAToVLZyj3oJACKk-tyGGovpFd4Q\",\n  \"token_type\": \"Bearer\",\n  \"expires_in\": 600\n}"
+    }
+  }
+}