plugzapi-gem 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0017b1d6c7794ad1e36a4a8bd78d5b5218012bdc797c783b18332333f4211a27
+  data.tar.gz: 9e3e286b3b4adad999b5c3a6d99362de46d275242470b6022144a3404ace4aea
+SHA512:
+  metadata.gz: 8cb84f75ed446391edbf1330f0a1d0772e879af19cbb1f5f3bb5f5ba46afe5dbdad8dda50e519d9bd6bb495b1f6a9c914090fe0a2026a3c8b68bfb8b2195ba41
+  data.tar.gz: 668e1fde18ab764dec4a83186b418465412539d8101bafc46a6089a7cc064b9eb4c4eec2d6ca8eb97d66f05260b2db7074624e4c317a028266a8d3b0d90dbc6d

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,10 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/Documentation: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-09-11
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/README.md

@@ -0,0 +1,92 @@
+# Plugzapi::Gem
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/plugzapi/gem`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+Para instalar a gem no projeto basta adicionar o seguinte trecho no Gemfile:
+
+```ruby
+...
+gem 'pegar_o_path_que_vai_gerar_no_gitlab'
+```
+
+Para testar localmente é possível instalar a gem executando o seguinte comando no terminal:
+
+```bash
+gem install ./plugzapi-gem.gem
+```
+
+instalando a gem é preciso criar um initializer para passar algumas variaveis para gem. Segue um exemplo:
+
+```ruby
+Plugzapi.configure do |config|
+  config.first_value = "primeiro valor"
+  config.second_value = "segundo valor"
+end
+```
+
+## Usage
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+O desenvolvimento se concentra dentro da pasta lib/plugzapi. Seguindo a estrutura que temos de exemplo na classe Soma que fica dentro do Calculator.
+
+```ruby
+module Plugzapi
+  module Calculator
+    class Soma
+      attr_reader :value1, :value2
+  
+      def self.perform(value1, value2)
+        new(value1, value2).call
+      end
+  
+      def initialize(value1, value2)
+        @value1 = value1
+        @value2 = value2
+      end
+  
+      def call
+        puts value1 + value2
+        puts "---------------"
+        Plugzapi.configuration.valor_dos_parametros
+      end
+    end
+  end
+end
+```
+
+Segue um exemplo de como usar essa classe em uma aplicação que possui a gem instalada e configurada:
+
+```ruby
+ Plugzapi::Calculator::Soma.perform(4, 6)
+```
+
+Isso vai retornar o seguinte:
+
+```bash
+10
+---------------
+first_value = primeiro valor
+second_value = segundo valor
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/plugzapi-gem. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/plugzapi-gem/blob/master/CODE_OF_CONDUCT.md).
+
+## Code of Conduct
+
+Everyone interacting in the Plugzapi::Gem project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/plugzapi-gem/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+This gem is licensed under the MIT License. See the [LICENSE](./LICENSE) file for more information.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/plugzapi/configuration.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Plugzapi
+  class Configuration
+    attr_accessor :client_token
+
+    def initialize
+      @client_token = nil
+    end
+  end
+
+  @configuration = Configuration.new
+
+  class << self
+    attr_accessor :configuration
+
+    def configure
+      yield(configuration)
+    end
+  end
+end

data/lib/plugzapi/connections.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Plugzapi
+  # This main class is for connections with the PlugZapi API. The other classes that
+  # will integrate with endpoints need to inherit from Connections.
+  class Connections
+    attr_reader :instance_id, :token
+
+    def self.perform(instance_id:, token:)
+      new(instance_id, token).call
+    end
+    
+    def initialize(instance_id, token)
+      @instance_id = instance_id
+      @token = token
+    end
+
+    # The call method will invoke response and return the API request's response.
+    def call
+      parsed_response = JSON.parse(response.body).transform_keys{ |key| key.to_sym }
+
+      parsed_response[:status] = response.status
+
+      parsed_response
+    end
+
+    private
+
+    def base_url
+      "#{Plugzapi::Constants::BASE_URL}/#{instance_id}/token/#{token}"
+    end
+
+    def get
+      Faraday.get(url) do |req|
+        req.headers['Client-Token'] = client_token
+      end
+    end
+
+    def post
+      Faraday.new(url: url).post do |req|
+        req.headers['content-type'] = 'application/json'
+        req.headers['Client-Token'] = client_token
+        req.body = {
+          message: message,
+          phone: phone
+        }.to_json
+      end
+    end
+
+    def client_token
+      Plugzapi.configuration.client_token
+    end
+    
+    def response
+      raise NotImplementedError, "You must implement the response method"
+    end
+
+    def url
+      raise NotImplementedError, "You must implement the url method"
+    end
+
+    def client_token
+      Plugzapi.configuration.client_token
+    end
+  end
+end

data/lib/plugzapi/constants.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Plugzapi
+  class Constants
+    BASE_URL = "https://api.plugzapi.com.br/instances/"
+  end
+end

data/lib/plugzapi/disconnect.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Plugzapi
+  class Disconnect < Connections
+    private
+
+    def url
+      "#{base_url}/disconnect"
+    end
+
+    def response
+      @response ||= get
+    end
+  end
+end

data/lib/plugzapi/gem/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Plugzapi
+  module Gem
+    VERSION = "0.1.0"
+  end
+end

data/lib/plugzapi/gem.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "pry"
+require_relative "gem/version"
+require_relative "configuration"
+require_relative "constants"
+require_relative "connections"
+require_relative "get_qrcode"
+require_relative "instance_status"
+require_relative "validate_phone"
+require_relative "send_message"
+require_relative "disconnect"
+require_relative "restore_session"
+require_relative "restart"
+
+module Plugzapi
+  module Gem
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end

data/lib/plugzapi/get_qrcode.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Plugzapi
+  class GetQrcode < Connections
+    private
+
+    def url
+      "#{base_url}/qr-code/image"
+    end
+
+    def response
+      @response ||= get
+    end
+  end
+end

data/lib/plugzapi/instance_status.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Plugzapi
+  class InstanceStatus < Connections
+    private
+
+    def url
+      "#{base_url}/status"
+    end
+
+    def response
+      @response ||= get
+    end
+  end
+end

data/lib/plugzapi/restart.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Plugzapi
+  class Restart < Connections
+    private
+
+    def url
+      "#{base_url}/restart"
+    end
+
+    def response
+      @response ||= get
+    end
+  end
+end

data/lib/plugzapi/restore_session.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Plugzapi
+  class RestoreSession < Connections
+    private
+
+    def url
+      "#{base_url}/restore-session"
+    end
+
+    def response
+      @response ||= get
+    end
+  end
+end

data/lib/plugzapi/send_message.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Plugzapi
+  class SendMessage < Connections
+    attr_reader :instance_id, :token, :phone, :message
+
+    def self.perform(instance_id:, token:, phone:, message:)
+      new(instance_id, token, phone, message).call
+    end
+    
+    def initialize(instance_id, token, phone, message)
+      @instance_id = instance_id
+      @token = token
+      @phone = phone
+      @message = message
+    end
+
+    private
+
+    def url
+      "#{base_url}/send-text"
+    end
+
+    def response
+      @response ||= post
+    end
+  end
+end

data/lib/plugzapi/validate_phone.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Plugzapi
+  class ValidatePhone < Connections
+    attr_reader :instance_id, :token, :phone
+
+    def self.perform(instance_id:, token:, phone:)
+      new(instance_id, token, phone).call
+    end
+    
+    def initialize(instance_id, token, phone)
+      @instance_id = instance_id
+      @token = token
+      @phone = phone
+    end
+
+    private
+
+    def url
+      "#{base_url}/phone-exists/#{phone}"
+    end
+
+    def response
+      @response ||= get
+    end
+  end
+end

data/sig/plugzapi/gem.rbs

@@ -0,0 +1,6 @@
+module Plugzapi
+  module Gem
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: plugzapi-gem
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Keslley
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "    A plugzapi-gem facilita a integração com a API da Tecnospeed, permitindo
+  a automação do envio de mensagens via WhatsApp. \n    Com uma interface simples
+  e intuitiva, desenvolvedores podem realizar chamadas à API da Plugzapi sem complicações,
+  \n    otimizando o tempo de desenvolvimento para um integração com WhatsApp\n"
+email:
+- capelin.cvv@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- README.md
+- Rakefile
+- lib/plugzapi/configuration.rb
+- lib/plugzapi/connections.rb
+- lib/plugzapi/constants.rb
+- lib/plugzapi/disconnect.rb
+- lib/plugzapi/gem.rb
+- lib/plugzapi/gem/version.rb
+- lib/plugzapi/get_qrcode.rb
+- lib/plugzapi/instance_status.rb
+- lib/plugzapi/restart.rb
+- lib/plugzapi/restore_session.rb
+- lib/plugzapi/send_message.rb
+- lib/plugzapi/validate_phone.rb
+- sig/plugzapi/gem.rbs
+homepage: https://gitlab.limbersoftware.com.br/way-v/plugzapi-gem
+licenses:
+- MIT
+metadata:
+  license: MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key: 
+specification_version: 4
+summary: Gem para integrar com a API Plugzapi da Tecnospeed para envio de mensagens
+  via WhatsApp
+test_files: []