bigid_auth 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f45c2559c85156c23be8006c158e2d2ad481f24df3b249492e91bc78ce98bbc
-  data.tar.gz: f5960d62a9124cdadf99b259775e90249d0e4e4d629f1a6f38ca9ebd17f337ff
+  metadata.gz: 7cae484adde1a8537c29863c0ec2eaf28dd89632a95605c8120546b8b7a5b6b0
+  data.tar.gz: ad11c04490bbd147bf9ebe570ec3fa53d7451f175b7197430cb7aa6001b48527
 SHA512:
-  metadata.gz: a51b222efcc1a2d424473b6bb4ee0ddb59fd27a2f5fef7d52d2575285ddff408f538481cf2986a32fbb0b69553fd898ed567e9986e9dcc9b8cd4268aea976e09
-  data.tar.gz: 77071623167b535be8197fecd123bc102a4dc015620f2e1f334efaac59bf1a691e85326ec04ee6fb7a4cbe2b9b8a2df3b585c2359400ba827551036822340cc8
+  metadata.gz: e4ef820360f66f94daf90d523bf150aaea64552c1421e8408cbd0cecf828c68284ecbed699d6daea57f5d06d00302da35c9654c9110a4ed7b8abf2cdb153dde9
+  data.tar.gz: 42a4c5181bd9692faa5f64bf56840e57f9671e0cec05090fe88022a4e29c79db91d874f60bdc67622c86b0dc3aa86ea43586a7171c2c3244843ea85f4154031b

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## v0.2.0
+
+* Use the gem "flash_integration" to retrieve a connection
+
 ## v0.1.1
 
 * Fix a problem with the locale initialization in Rails projects

data/README.md

@@ -3,6 +3,7 @@ BigId Auth's Library for Ruby
 
 [![Gem Version](https://badge.fury.io/rb/bigid_auth.svg)](https://badge.fury.io/rb/bigid_auth)
 [![Build Status](https://travis-ci.com/Quasar-Flash/bigid-auth-ruby.svg?branch=master)](https://travis-ci.com/Quasar-Flash/bigid-auth-ruby)
+[![bigid_auth](https://github.com/Quasar-Flash/bigid-auth-ruby/actions/workflows/ruby.yml/badge.svg)](https://github.com/Quasar-Flash/bigid-auth-ruby/actions/workflows/ruby.yml)
 
 Dev Requirements
 -----------------
@@ -13,76 +14,97 @@ Dev Requirements
 Global Installation
 -----------------
 
-    gem install bigid_auth
+```ruby
+gem install bigid_auth
+```
 
 Installation for Rails
 -----------------
 
-    # Add to the Gemfile
-    gem 'bigid_auth', '~> 0.1.0'
-
-Setting the BigID credentials
------------------
-
-    # Set the env variables
-    ENV['BIGID_USERNAME'] = 'your_username'
-    ENV['BIGID_PASSWORD'] = 'your_password'
+```ruby
+# Add to the Gemfile
+gem "bigid_auth", '~> 0.1.0'
+```
 
 Setting the BigID credentials - Rails Project
 -----------------
 
 Create the config/initializers/bigid.rb file and define:
 
-    # Set the env variables
-    Bigid.configure do |config|
-        config.username = 'your_username'
-        config.password = 'your_password'
-    end
+```ruby
+# Set the env variables
+Bigid.configure do |config|
+  config.username = 'JHONNY.MUNIS@QFLASH.COM.BR'
+  config.password = 'crtvreru'
+end
+```
 
 Applying an authentication
 -----------------
 
-    require 'bigid_auth'
+```ruby
+require 'bigid_auth'
 
-    auth = Bigid::Auth::Authentication.new
-    auth.login
+Bigid::Auth::Authentication.new.login
+```
 
 Result Example
 -----------------
 
-    #<Bigid::Auth::Integration::Response:0x0000564181d2bef0
-        @request=#<Bigid::Auth::Integration::Request:0x0000564181d76a18
-            @method=:post,
-            @url="https://accesstoken.bigdatacorp.com.br/Generate",
-            @params={},
-            @headers={:"Content-Type"=>"application/json", :Accept=>"application/json"},
-            @body="{\"login\":\"username\",\"password\":\"crtvreru\",\"expires\":60000}",
-            @time=2021-04-18 18:55:24.678349974 UTC>,
-            @status=200,
-            @body="{\"expiration\":\"Mon, 21 Feb 2028 18:55:24 GMT\",\"message\":\"Token Generated\",\"success\":true,\"token\":\"xxxxxxxxxxxx\",\"tokenID\":\"0000000000\"}\n", @time=2021-04-18 18:55:24.995163484 UTC>
+```ruby
+<Flash::Integration::Response:xxxx
+  @request=<Flash::Integration::Request:xxx
+    @method = :post,
+    @url = "https://accesstoken.bigdatacorp.com.br/Generate",
+    @params = {},
+    @headers = {
+      :"Content-Type" => "application/json",
+      :Accept => "application/json"
+    },
+    @body = "{\"login\":\"email@email.com\",\"password\":\"xxxxxx\",\"expires\":60000}",
+    @time = 2021-07-21 22:49:57.869382432 UTC>,
+  @status = 200,
+  @headers = {
+    "content-type" => "application/json",
+    "content-length" => "361",
+    "connection" => "keep-alive",
+    "date" => "Wed, 21 Jul 2021 22:49:58 GMT"
+  },
+  @body="{\"expiration\":\"Thu, 25 May 2028 22:49:58 GMT\",\"message\":\"Token Generated\",\"success\":true,\"token\":\"xxx\",\"tokenID\":\"xxx\"}\n",
+  @time=2021-07-21 22:49:58.248277077 UTC>
+
+```
 
 Problems?
 -----------------
 
-**Please do not directly email any committers with questions or problems.**  A community is best served when discussions are held in public.
+**Please do not directly email any committers with questions or problems.**  A
+community is best served when discussions are held in public.
 
-Searching the [issues](https://github.com/Quasar-Flash/bigid-auth-ruby/issues) for your problem is also a good idea.
+Searching the [issues](https://github.com/Quasar-Flash/bigid-auth-ruby/issues)
+for your problem is also a good idea.
 
 Contributing
 -----------------
 
-- Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet;
-- Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it;
+- Check out the latest master to make sure the feature hasn't been implemented
+or the bug hasn't been fixed yet;
+- Check out the issue tracker to make sure someone already hasn't requested it
+and/or contributed it;
 - Fork the project;
 - Start a feature/bugfix branch;
 - Commit and push until you are happy with your contribution;
-- Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.;
-- Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+- Make sure to add tests for it. This is important so I don't break it in a
+future version unintentionally.;
+- Please try not to mess with the Rakefile, version, or history. If you want to
+have your own version, or is otherwise necessary, that is fine, but please
+isolate to its own commit so I can cherry-pick around it.
 
 License
 -----------------
 
-Please see [LICENSE](https://github.com/Quasar-Flash/bigid-auth-ruby/blob/master/LICENSE.txt) for licensing details.
+Please see [LICENSE](https://github.com/Quasar-Flash/bigid-auth-ruby/blob/master/LICENSE.txt)
+for licensing details.
 
 Authors
 -----------------

data/Rakefile

@@ -45,4 +45,4 @@ rescue LoadError
   # no rspec available
 end
 
-task default: %i[rubocop ]
+task default: %i[rubocop spec]

data/lib/bigid/auth/connection.rb

@@ -2,7 +2,7 @@
 
 module Bigid
   module Auth
-    class Connection < Bigid::Auth::Integration::Connection
+    class Connection < Flash::Integration::Connection
       def initialize(request_class: Faraday, base_url: Bigid::Auth::AUTH_ENDPOINT)
         super(request_class: request_class, base_url: base_url)
       end

data/lib/bigid/auth/version.rb

@@ -9,6 +9,6 @@ module Bigid
     # Major - Incremented for incompatible changes with previous release (or big enough new features)
     # Minor - Incremented for new backwards-compatible features + deprecations
     # Patch - Incremented for backwards-compatible bug fixes
-    VERSION = "0.1.1"
+    VERSION = "0.2.0"
   end
 end

data/lib/bigid_auth.rb

@@ -1,16 +1,11 @@
 # frozen_string_literal: true
 
-require "faraday"
+require "flash_integration"
 require "i18n"
 require "json"
 
 require "bigid/auth/version"
 
-require "bigid/auth/integration/multipart_flat"
-require "bigid/auth/integration/response"
-require "bigid/auth/integration/request"
-require "bigid/auth/integration/connection"
-
 require "bigid/auth/connection"
 require "bigid/auth/authentication"
 require "bigid/auth/authenticated_resource"

data/spec/bigid_auth_spec.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "spec_helper"
-require "bigid_auth"
 
 RSpec.describe Bigid::Auth do
   describe "AUTH_ENDPOINT" do
@@ -18,15 +17,15 @@ RSpec.describe Bigid::Auth do
 
   describe ".configure" do
     before do
-      described_class.configuration = nil
+      Bigid.configuration = nil
       ENV.clear
     end
 
-    subject { described_class.configuration }
+    subject { Bigid.configuration }
 
     context "when configuration is defined" do
       before do
-        described_class.configure do |config|
+        Bigid.configure do |config|
           config.username = "username_value"
           config.password = "password_value"
         end
@@ -65,7 +64,7 @@ RSpec.describe Bigid::Auth do
         ENV["BIGID_USERNAME"] = "username_value"
         ENV["BIGID_PASSWORD"] = "password_value"
 
-        described_class.configure do |config|
+        Bigid.configure do |config|
           config.username = "username_value2"
           config.password = "password_value2"
         end

data/spec/spec_helper.rb

@@ -1,7 +1,20 @@
 # frozen_string_literal: true
 
+require "simplecov"
+
+SimpleCov.formatters = [SimpleCov::Formatter::HTMLFormatter]
+SimpleCov.minimum_coverage 70.0
+
+SimpleCov.start do
+  add_filter "/spec/"
+  minimum_coverage 70
+  minimum_coverage_by_file 40
+end
+
 require "rubygems"
 require "bundler"
+require "bigid_auth"
+require "pry"
 
 begin
   Bundler.setup(:default, :development, :test)
@@ -12,14 +25,13 @@ rescue Bundler::BundlerError => e
   exit e.status_code
 end
 
-require "simplecov"
-
-SimpleCov.start do
-  add_filter "spec"
-end
-
 RSpec.configure do |config|
-  # some (optional) config here
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
 end
 
 # minitest/mock # Uncomment me to use minitest mocks

metadata

@@ -1,35 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: bigid_auth
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Danilo Carolino
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-19 00:00:00.000000000 Z
+date: 2021-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: flash_integration
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.1
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.1
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
@@ -90,14 +84,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.1.0
+        version: 6.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.1.0
+        version: 6.2.0
 - !ruby/object:Gem::Dependency
   name: gemsurance
   requirement: !ruby/object:Gem::Requirement
@@ -166,14 +160,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.0
+        version: 1.18.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.0
+        version: 1.18.3
 - !ruby/object:Gem::Dependency
   name: rubocop-packaging
   requirement: !ruby/object:Gem::Requirement
@@ -194,14 +188,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: 1.11.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: 1.11.4
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -234,10 +228,6 @@ files:
 - lib/bigid/auth/bad_request_error.rb
 - lib/bigid/auth/base_error.rb
 - lib/bigid/auth/connection.rb
-- lib/bigid/auth/integration/connection.rb
-- lib/bigid/auth/integration/multipart_flat.rb
-- lib/bigid/auth/integration/request.rb
-- lib/bigid/auth/integration/response.rb
 - lib/bigid/auth/invalid_credentials_error.rb
 - lib/bigid/auth/server_error.rb
 - lib/bigid/auth/version.rb

data/lib/bigid/auth/integration/connection.rb

@@ -1,120 +0,0 @@
-# frozen_string_literal: true
-
-module Bigid
-  module Auth
-    module Integration
-      class Connection
-        attr_reader :base_url
-
-        def initialize(base_url:, request_class: Faraday)
-          @request_class = request_class
-          @base_url = base_url
-        end
-
-        def get(url: "", params: {}, headers: {})
-          send_request(
-            method: :get,
-            url: url,
-            params: params,
-            headers: headers
-          )
-        end
-
-        def post(url: "", params: {}, headers: {}, body: {}, multipart: false)
-          send_request(
-            method: :post,
-            url: url,
-            params: params,
-            headers: headers,
-            body: body,
-            multipart: multipart
-          )
-        end
-
-        def put(url: "", params: {}, headers: {}, body: {})
-          send_request(
-            method: :put,
-            url: url,
-            params: params,
-            headers: headers,
-            body: body
-          )
-        end
-
-        def patch(url: "", params: {}, headers: {}, body: {})
-          send_request(
-            method: :patch,
-            url: url,
-            params: params,
-            headers: headers,
-            body: body
-          )
-        end
-
-        def delete(url: "", params: {}, headers: {}, body: {})
-          send_request(
-            method: :delete,
-            url: url,
-            params: params,
-            headers: headers,
-            body: body
-          )
-        end
-
-        def default_headers
-          {}
-        end
-
-        private
-          def send_request(method:, url:, params:, headers:, body: nil, multipart: false)
-            connection = multipart ? multipart_connection : @request_class.new(url: @base_url)
-
-            merged_headers = default_headers.merge(headers)
-
-            request = build_request(
-              method, connection.build_url(url).to_s, params, merged_headers, body
-            )
-
-            result =
-              connection.send(method) do |request|
-                request.url(url)
-                request.params = params
-                request.headers = merged_headers
-                request.body = body if body
-              end
-
-            build_response(request, result.status, result.headers, result.body)
-          end
-
-          def multipart_connection
-            @request_class.new(url: @base_url) do |conn|
-              conn.use Bigid::Auth::Integration::MultipartFlat
-              conn.request :url_encoded
-              conn.adapter @request_class.default_adapter
-            end
-          end
-
-          def build_request(method, url, params, headers, body)
-            Bigid::Auth::Integration::Request.new(
-              method: method,
-              url: url,
-              params: params,
-              headers: headers,
-              body: body,
-              time: Time.now.utc
-            )
-          end
-
-          def build_response(request, status, headers, body)
-            Bigid::Auth::Integration::Response.new(
-              request: request,
-              status: status,
-              headers: headers,
-              body: body,
-              time: Time.now.utc
-            )
-          end
-      end
-    end
-  end
-end

data/lib/bigid/auth/integration/multipart_flat.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module Bigid
-  module Auth
-    module Integration
-      class MultipartFlat < Faraday::Request::Multipart
-        self.mime_type = "multipart/form-data"
-        DEFAULT_BOUNDARY_PREFIX = "-----------RubyMultipartPost" unless defined? DEFAULT_BOUNDARY_PREFIX
-
-        def process_params(params, prefix = nil, pieces = nil, &block)
-          params.inject(pieces || []) do |all, (key, value)|
-            key = prefix.to_s if prefix
-
-            case value
-            when Array
-              values = value.inject([]) { |a, v| a << [nil, v] }
-              process_params(values, key, all, &block)
-            when Hash
-              process_params(value, key, all, &block)
-            else
-              all << block.call(key, value)
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/bigid/auth/integration/request.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module Bigid
-  module Auth
-    module Integration
-      class Request
-        attr_reader :method, :url, :params, :headers, :body, :time
-
-        def initialize(attributes)
-          @method = attributes.fetch(:method)
-          @url = attributes.fetch(:url)
-          @params = attributes[:params] || {}
-          @headers = attributes[:headers] || {}
-          @body = attributes[:body] || {}
-          @time = attributes[:time] || Time.current
-        end
-      end
-    end
-  end
-end

data/lib/bigid/auth/integration/response.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module Bigid
-  module Auth
-    module Integration
-      class Response
-        attr_reader :request, :status, :headers, :body, :time
-
-        def initialize(attributes)
-          @request = attributes.fetch(:request)
-          @status = attributes.fetch(:status)
-          @headers = attributes[:headers] || {}
-          @body = attributes[:body] || {}
-          @time = attributes[:time] || Time.current
-        end
-
-        def success?
-          @status.between?(200, 299)
-        end
-
-        def error?
-          !success?
-        end
-      end
-    end
-  end
-end