flash_integration 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b2f23dde3fb12c40861560bd60bb180f1586f63095a7f9d29ad23dd9d930f777
+  data.tar.gz: 201d2a58f30ee5084bd5feefa3b2e156063aa2d23a2b5d92473dbff2bb150731
+SHA512:
+  metadata.gz: 221cc98e24c5a4108e315baff391197488ce22f40f1734c84681328b2beb86a8202948152b7d62e96f41816efc9635309317b1061aaaa365081888e0962d7ee6
+  data.tar.gz: 816300806c206582b671275bce3b9355154683780dce4b750a74744d18e7e0a8792c024d0ff9d07c1aa5e63c239f0547419087f15fce645e40b8df39c0417d67

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# CHANGELOG
+
+## v0.1.0
+
+* Initial release

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 QFlash
+
+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,86 @@
+BigId Auth's Library for Ruby
+==============
+
+[![Gem Version](https://badge.fury.io/rb/flash_integration.svg)](https://badge.fury.io/rb/flash_integration)
+[![Build Status](https://travis-ci.com/Quasar-Flash/flash-integration-ruby.svg?branch=master)](https://travis-ci.com/Quasar-Flash/flash-integration-ruby)
+
+Dev Requirements
+-----------------
+
+- Ruby: Any version
+- Bundler
+
+Global Installation
+-----------------
+
+    gem install flash_integration
+
+Installation for Rails
+-----------------
+
+    # Add to the Gemfile
+    gem 'flash_integration', '~> 0.1.0'
+
+Example - How to extend
+-----------------
+
+    module MyApp
+        class Connection < Flash::Integration::Connection
+            def initialize(base_url: "http://localhost")
+                super(base_url: base_url)
+            end
+
+            def default_headers
+                {
+                    "Accept":       "application/json",
+                    "Content-Type": "application/json"
+                }
+            end
+        end
+    end
+
+Example - How to request
+-----------------
+
+    res = @connection.post(
+        method: :post,
+        url: url,
+        params: {},
+        headers: {},
+        body: body, # except for get
+        multipart: multipart # only for post
+    )
+    res # Flash::Integration::Response type
+    res.request
+    res.status
+    res.headers
+    res.body
+    res.time
+
+Problems?
+-----------------
+
+**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/flash-integration-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;
+- 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.
+
+License
+-----------------
+
+Please see [LICENSE](https://github.com/Quasar-Flash/flash-integration-ruby/blob/master/LICENSE.txt) for licensing details.
+
+Authors
+-----------------
+
+Danilo Carolino, [@danilogco](https://github.com/danilogco) / [@Quasar-Flash](https://github.com/Quasar-Flash)

data/Rakefile

@@ -0,0 +1,49 @@
+#!/usr/bin/env rake
+# frozen_string_literal: true
+
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+begin
+  require "rdoc/task"
+rescue LoadError
+  require "rdoc/rdoc"
+  require "rake/rdoctask"
+
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "flash_integration"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.rdoc")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+Bundler::GemHelper.install_tasks
+
+begin
+  require "rake/testtask"
+  require "rubocop/rake_task"
+
+  RuboCop::RakeTask.new(:rubocop) do |t|
+    t.requires << "rubocop-rspec"
+    t.options = ["--display-cop-names"]
+  end
+rescue LoadError
+  # no rspec available
+end
+
+begin
+  require "rspec/core/rake_task"
+
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+  # no rspec available
+end
+
+task default: %i[rubocop spec]

data/lib/flash/integration/connection.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module Flash
+  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 Flash::Integration::MultipartFlat
+            conn.request :url_encoded
+            conn.adapter @request_class.default_adapter
+          end
+        end
+
+        def build_request(method, url, params, headers, body)
+          Flash::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)
+          Flash::Integration::Response.new(
+            request: request,
+            status: status,
+            headers: headers,
+            body: body,
+            time: Time.now.utc
+          )
+        end
+    end
+  end
+end

data/lib/flash/integration/multipart_flat.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Flash
+  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

data/lib/flash/integration/request.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Flash
+  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.now.utc
+      end
+    end
+  end
+end

data/lib/flash/integration/response.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Flash
+  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.now.utc
+      end
+
+      def success?
+        @status.between?(200, 299)
+      end
+
+      def error?
+        !success?
+      end
+    end
+  end
+end

data/lib/flash/integration/version.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Flash
+  module Integration
+    # When updating version, keep in mind Semantic Versioning http://semver.org/
+    # TL;DR; (Major.Minor.Patch)
+    # Releases before 1.0.0 are in active development and can change anytime
+    # 1.0.0 and up is indication and declaration of a stable public API
+    # 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.0"
+  end
+end

data/lib/flash_integration.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "faraday"
+
+require "flash/integration/version"
+require "flash/integration/multipart_flat"
+require "flash/integration/response"
+require "flash/integration/request"
+require "flash/integration/connection"
+
+module Flash::Integration
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+
+    yield(configuration)
+  end
+
+  class Configuration
+  end
+end

data/spec/flash/integration/connection_spec.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe Flash::Integration::Connection do
+  let(:base_url) { "http://localhost" }
+  let(:connection) { Faraday::Connection.new(url: base_url) }
+  let(:instance) { described_class.new(request_class: request_class, base_url: base_url) }
+  let(:request_params) { double("request-params") }
+  let(:request_class) { class_double(Faraday, default_adapter: double("request-params")) }
+  let(:request_headers) { {} }
+  let(:request_body) { double("request-body") }
+  let(:response_status) { double("response-status") }
+  let(:response_headers) { double("response-headers") }
+  let(:response_body) { double("response-body") }
+  let(:time) { Time.now.utc }
+  let(:multipart) { nil }
+
+  let(:response) do
+    double(
+      "response",
+      request: request,
+      status: response_status,
+      headers: response_headers,
+      body: response_body
+    )
+  end
+  let(:request) do
+    Flash::Integration::Request.new(
+      method: http_protocol,
+      url: base_url,
+      params: request_params,
+      headers: request_headers,
+      body: request_body,
+      time: time
+    )
+  end
+
+  shared_examples "successful_request" do |http_protocol|
+    let(:http_protocol) { http_protocol.to_sym }
+    let(:args) { { url: base_url, params: request_params, headers: request_headers, body: request_body } }
+
+    subject { instance.send(http_protocol, **args) }
+
+    before do
+      allow(request_class).to receive(:new).and_return(connection)
+      allow(connection).to receive(http_protocol).and_return(response)
+    end
+
+    it { subject; expect(request_class).to have_received(:new) }
+
+    it { subject; expect(connection).to have_received(http_protocol) }
+
+    it { expect(subject.request).to have_attributes(
+      method: http_protocol,
+      url: base_url,
+      params: request_params,
+      headers: request_headers,
+      body: request_body)
+    }
+
+    it { expect(subject.time).to be_kind_of(Time) }
+
+    it { expect(subject.status).to eq(response_status) }
+
+    it { expect(subject.headers).to eq(response_headers) }
+
+    it { expect(subject.body).to eq(response_body) }
+
+    it { expect(connection.adapter).to eq(Faraday::Adapter::NetHttp) }
+
+    it { expect(connection.builder.handlers).to eq([Faraday::Request::UrlEncoded]) }
+  end
+
+  describe "#get" do
+    include_examples "successful_request", :get
+
+    let!(:args) { { url: base_url, params: request_params, headers: request_headers } }
+    let(:request_body) { {} }
+  end
+
+  describe "#post" do
+    include_examples "successful_request", :post
+
+    let!(:args) { { url: base_url, params: request_params, headers: request_headers, body: request_body, multipart: true } }
+  end
+
+  describe "#put" do
+    include_examples "successful_request", :put
+  end
+
+  describe "#patch" do
+    include_examples "successful_request", :patch
+  end
+
+  describe "#delete" do
+    include_examples "successful_request", :delete
+  end
+end

data/spec/flash/integration/response_spec.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe Flash::Integration::Response do
+  let(:request) { double("request") }
+  let(:instance) { described_class.new(request: request, status: status) }
+
+  describe "#success?" do
+    subject { instance.success? }
+
+    context "when the status code is between 200 and 299" do
+      let(:status) { 250 }
+
+      it { expect(subject).to be_truthy }
+    end
+
+    context "when the status code is not between 200 and 299" do
+      let(:status) { 500 }
+
+      it { expect(subject).to be_falsey }
+    end
+  end
+
+  describe "#error?" do
+    subject { instance.error? }
+
+    context "when the status code is between 200 and 299" do
+      let(:status) { 250 }
+
+      it { expect(subject).to be_falsey }
+    end
+
+    context "when the status code is not between 200 and 299" do
+      let(:status) { 500 }
+
+      it { expect(subject).to be_truthy }
+    end
+  end
+end

data/spec/flash_integration_spec.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+require "flash_integration"
+
+RSpec.describe Flash::Integration do
+  describe ".configure" do
+    before do
+      described_class.configuration = nil
+      ENV.clear
+    end
+
+    subject { described_class.configuration }
+
+    context "when configuration is defined" do
+      before do
+        described_class.configure do |config|
+        end
+      end
+
+      it { expect(subject).not_to be_nil }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "rubygems"
+require "bundler"
+require "pry"
+require "flash_integration"
+
+begin
+  Bundler.setup(:default, :development, :test)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn "Run `bundle install` to install missing gems"
+
+  exit e.status_code
+end
+
+require "simplecov"
+
+SimpleCov.start do
+  add_filter "spec"
+end
+
+RSpec.configure do |config|
+  config.alias_example_group_to :detail, detailed: true
+end

metadata

@@ -0,0 +1,216 @@
+--- !ruby/object:Gem::Specification
+name: flash_integration
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Danilo Carolino
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.12.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.12.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-packaging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+description: A library to make easily to build integrations
+email:
+- danilo.carolino@qflash.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- Rakefile
+- lib/flash/integration/connection.rb
+- lib/flash/integration/multipart_flat.rb
+- lib/flash/integration/request.rb
+- lib/flash/integration/response.rb
+- lib/flash/integration/version.rb
+- lib/flash_integration.rb
+- spec/flash/integration/connection_spec.rb
+- spec/flash/integration/response_spec.rb
+- spec/flash_integration_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Quasar-Flash/flash-integration-ruby
+licenses:
+- MIT
+metadata:
+  changelog_uri: https://github.com/Quasar-Flash/flash-integration-ruby/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/Quasar-Flash/flash-integration-ruby
+  bug_tracker_uri: https://github.com/Quasar-Flash/flash-integration-ruby/issues
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.16
+signing_key:
+specification_version: 4
+summary: Flash Integration Library
+test_files:
+- spec/flash/integration/connection_spec.rb
+- spec/flash/integration/response_spec.rb
+- spec/flash_integration_spec.rb
+- spec/spec_helper.rb