gupshup-rb 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d6577d6f29f793144a4b60751fa117bca7bf8feb2ffb1ab5a4c8cd7452d2758
-  data.tar.gz: 4fabc61bdbbce092c9cadd714277d5291aeeefedc46dff27d550deb8b7b4ad0f
+  metadata.gz: 28476dad0e6c5d22419bb1506c488c34f65f5caf73b69cf423f084128f65c9ee
+  data.tar.gz: 8a3e629dc4fe625cdcfbb828deaedaa1d06659533073497a7ec19347c6dfcb12
 SHA512:
-  metadata.gz: acd980b9490ae458b891a30cff235e857f6787090cf2822e3b6c3aa53b9da8f4315b18c632493ef6d54c6a68c2e9431e32a23ab5760a135bdf96fccea7c0f1c8
-  data.tar.gz: 10f1980c321be951431f601eecfb26054a2d213a8871eb1eab2317910d8b5d3e2824777bb512255a580c29ade9f0d54e3b1821f8c17273ac94db10da726e0997
+  metadata.gz: 882a50f9da161b1c59265b03be1b0bdc4663cc797eaff097f752f52e55dea151f11c62a59e165e6d387935c95e117b8fe5d684681c8065c2f3e949ad561e47d5
+  data.tar.gz: be20db4668983c8d2d944b7c56edf6d79223d86784b6ae4a7d05742dce37a8f343e0726ed426873d61268fd23646b0833398f0ff5f8f111289d84763fe797637

data/.gitignore

@@ -0,0 +1,17 @@
+*~
+!.rubocop_todo.yml
+!.rubocop.yml
+!.travis.yml
+!.dockerignore
+pkg/*
+doc/*
+Gemfile.lock
+*.gem
+docs/_build
+*.bak
+*.iml
+.bundle
+.rakeTasks
+.yardoc
+
+coverage

data/.rubocop.yml

@@ -0,0 +1,59 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 2.5
+  Exclude:
+    - 'lib/gupshup-rb/rest/**/*'
+    - 'spec/integration/**/*'
+    - 'lib/gupshup-rb/version.rb'
+    - 'lib/gupshup-rb/twiml/**/*'
+    - 'lib/gupshup-rb/util/configuration.rb'
+    - 'vendor/**/*'
+
+Layout/LineLength:
+  Max: 120
+  Exclude:
+    - 'spec/**/*'
+
+Style/BlockDelimiters:
+  Exclude:
+    - 'spec/**/*'
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - gupshup-rb.gemspec
+
+Layout/HeredocIndentation:
+  Enabled: false
+
+Metrics/ClassLength:
+  Max: 175
+
+Metrics/MethodLength:
+  Max: 25
+
+Metrics/ParameterLists:
+  Max: 20
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: false
+
+Style/HashTransformValues:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-08-01
+## [0.1.2] - 2023-08-10
+## [0.1.3] - 2023-08-21
+## [0.1.4] - 2023-08-22
+## [0.1.5] - 2023-09-01
+## [0.1.6] - 2023-09-01
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,62 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gem 'simplecov', require: false, group: :test
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (C) 2023
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 TODO: Write your name
+
+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

@@ -35,4 +35,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Gupshup::Rb project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/raimartinsb/gupshup-rb/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Gupshup::Rb project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/raimartinsb/gupshup-rb/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler'
+Bundler.setup
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+desc 'Run all specs'
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+task test: :spec

data/bin/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "gupshup-rb"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+Gupshup::Console.new.start 

data/bin/setup

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'  # Isso carregará o Bundler para instalar dependências, se necessário
+
+# Outras configurações de inicialização da sua gem, se necessário

data/gupshup-rb.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gupshup-rb/version'                                           
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gupshup-rb'
+  spec.version       = Gupshup::VERSION
+  spec.authors       = ['Raimundo Martins']
+  spec.summary       = 'Communication with Chatwoot - Not Completed! Still does not work!'
+  spec.description   = 'Communication with Chatwoot - Not Completed! Still does not work!'
+  spec.homepage      = 'https://github.com/raimartinsb/gupshup-rb'
+  spec.license       = 'MIT'
+  spec.metadata      = { 'yard.run' => 'yri' } # use "yard" to build full HTML docs
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match?(%r{^(spec)/}) }
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.0.0'
+  spec.extra_rdoc_files = ['README.md', 'LICENSE']
+  spec.rdoc_options = ['--line-numbers', '--inline-source', '--title', 'gupshup-rb', '--main', 'README.md']
+
+  spec.add_dependency('jwt', '>= 1.5', '< 3.0')
+  spec.add_dependency('nokogiri', '>= 1.6', '< 2.0')
+  spec.add_dependency('faraday', '>= 0.9', '< 3.0')
+  # Workaround for RBX <= 2.2.1, should be fixed in next version
+  spec.add_dependency('rubysl') if defined?(RUBY_ENGINE) && RUBY_ENGINE == 'rbx'
+
+  spec.add_development_dependency 'bundler', '>= 1.5', '< 3.0'
+  spec.add_development_dependency 'equivalent-xml', '~> 0.6'
+  spec.add_development_dependency 'fakeweb', '~> 1.3'
+  spec.add_development_dependency 'rack', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'yard', '~> 0.9.9'
+  spec.add_development_dependency 'logger', '~> 1.4.2'
+end

data/lib/gupshup-rb/framework/gupshup_response.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Gupshup
+  class GupshupResponse
+    attr_accessor :status_code, :body
+
+    # @deprecated Use 'Gupshup::Response' instead.
+    def initialize(status_code, body)
+      warn "'Gupshup::GupshupResponse' has been deprecated. Use 'Gupshup::Response' instead."
+      response = Gupshup::Response.new(status_code, body)
+      @status_code = response.status_code
+      @body = response.body
+    end
+
+    def to_s
+      "[#{@status_code}] #{@body}"
+    end
+  end
+end

data/lib/gupshup-rb/framework/request.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Gupshup
+  class Request
+    attr_reader :host, :port, :method, :url, :params, :data, :headers, :auth, :timeout
+
+    def initialize(host, port, method, url, params = {}, data = {}, headers = {}, auth = nil, timeout = nil)
+      @host = host
+      @port = port
+      @url = url
+      @method = method
+      @params = params
+      @data = data
+      @headers = headers
+      @auth = auth
+      @timeout = timeout
+    end
+
+    def to_s
+      auth = @auth.nil? ? '' : '(' + @auth.join(',') + ')'
+
+      params = ''
+      unless @params.nil? || @params.empty?
+        params = '?' + @params.each.map { |key, value| "#{CGI.escape(key)}=#{CGI.escape(value)}" }.join('&')
+      end
+
+      headers = ''
+      unless @headers.nil? || @headers.empty?
+        headers = "\n" + @headers.each.map { |key, value| "-H \"#{key}\": \"#{value}\"" }.join("\n")
+      end
+
+      data = ''
+      unless @data.nil? || @data.empty?
+        data = @method.equal?('GET') ? "\n -G" : "\n"
+        data += @data.each.map { |key, value| "-d \"#{key}\"=\"#{value}\"" }.join("\n")
+      end
+
+      "#{auth} #{@method} #{@url}#{params}#{data}#{headers}"
+    end
+  end
+end

data/lib/gupshup-rb/framework/response.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Gupshup
+  class Response
+    attr_accessor :status_code, :body, :headers
+
+    def initialize(status_code, body, headers: nil)
+      @status_code = status_code
+      body = '{}' if !body || body.empty?
+      @body = JSON.parse(body)
+      @headers = !headers ? {} : headers.to_hash
+    end
+
+    def to_s
+      "[#{status_code}] #{body}"
+    end
+  end
+end

data/lib/gupshup-rb/framework/rest/domain.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Gupshup
+  module REST
+    class Domain
+      attr_reader :client
+
+      def initialize(client)
+        @client = client
+        @host = nil
+        @base_url = nil
+        @port = nil
+      end
+
+      def absolute_url(uri)
+        "#{@base_url.chomp('/')}/#{uri.chomp('/').gsub(/^\//, '')}"
+      end
+
+      def request(method, uri, params = {}, data = {}, headers = {}, auth = nil, timeout = nil)
+        url = uri.match(/^http/) ? uri : absolute_url(uri)
+
+        @client.request(
+          @base_url,
+          @port,
+          method,
+          url,
+          params,
+          data,
+          headers,
+          auth,
+          timeout
+        )
+      end
+    end
+  end
+end

data/lib/gupshup-rb/framework/rest/error.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Gupshup
+  module REST
+    class GupshupError < StandardError
+      # @deprecated all errors that have a body are now 'Gupshup::RestError's
+      def body
+        warn "'Gupshup::REST::GupshupError#body' has been deprecated. No 'GupshupError' objects are raised with a body."
+        nil
+      end
+    end
+
+    class RestError < GupshupError
+      attr_reader :message, :response, :code, :status_code, :details, :more_info, :error_message
+
+      def initialize(message, response)
+        @status_code = response.status_code
+        @code = response.body.fetch('code', @status_code)
+        @details = response.body.fetch('details', nil)
+        @error_message = response.body.fetch('message', nil)
+        @more_info = response.body.fetch('more_info', nil)
+        @message = format_message(message)
+        @response = response
+      end
+
+      # @deprecated use #response instead
+      def body
+        warn 'This error used to be a "Gupshup::REST::GupshupError" but is now a "Gupshup::REST::RestError". ' \
+             'Please use #response instead of #body.'
+        @response
+      end
+
+      def to_s
+        message
+      end
+
+      private
+
+      def format_message(initial_message)
+        message = "[HTTP #{status_code}] #{code} : #{initial_message}"
+        message += "\n#{error_message}" if error_message
+        message += "\n#{details}" if details
+        message += "\n#{more_info}" if more_info
+        message + "\n\n"
+      end
+    end
+
+    class ObsoleteError < StandardError
+    end
+  end
+end

data/lib/gupshup-rb/framework/rest/helper.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Gupshup
+  module REST
+    def url_join(left, right)
+      left = left.sub(/\/+$/, '').sub(/^\/+/, '')
+      right = right.sub(/\/+$/, '').sub(/^\/+/, '')
+      "#{left}/#{right}"
+    end
+  end
+end

data/lib/gupshup-rb/framework/rest/obsolete_client.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Gupshup
+  module REST
+    class ObsoleteClient
+      def initialize(*)
+        raise ObsoleteError, "#{self.class} has been removed from this version of the library. "\
+                             'Please refer to current documentation for guidance.'
+      end
+    end
+  end
+end

data/lib/gupshup-rb/framework/rest/page.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+module Gupshup
+  module REST
+    # Page Base Class
+    class Page
+      include Enumerable
+
+      META_KEYS = [
+        'end',
+        'first_page_uri',
+        'next_page_uri',
+        'last_page_uri',
+        'page',
+        'page_size',
+        'previous_page_uri',
+        'total',
+        'num_pages',
+        'start',
+        'uri'
+      ].freeze
+
+      def initialize(version, response)
+        payload = process_response(response)
+
+        @version = version
+        @payload = payload
+        @solution = {}
+        @records = load_page(payload)
+      end
+
+      def process_response(response)
+        if response.status_code != 200
+          raise Gupshup::REST::RestError.new('Unable to fetch page', response)
+        end
+
+        response.body
+      end
+
+      def load_page(payload)
+        if payload['meta'] && payload['meta']['key']
+          return payload[payload['meta']['key']]
+        else
+          keys = payload.keys
+          key = keys - META_KEYS
+          return payload[key.first] if key.size == 1
+        end
+
+        raise Gupshup::REST::GupshupError, 'Page Records can not be deserialized'
+      end
+
+      def previous_page_url
+        if @payload['meta'] && @payload['meta']['previous_page_url']
+          return @version.domain.absolute_url(URI.parse(@payload['meta']['previous_page_url']).request_uri)
+        elsif @payload['previous_page_uri']
+          return @version.domain.absolute_url(@payload['previous_page_uri'])
+        end
+
+        nil
+      end
+
+      def next_page_url
+        if @payload['meta'] && @payload['meta']['next_page_url']
+          return @version.domain.absolute_url(URI.parse(@payload['meta']['next_page_url']).request_uri)
+        elsif @payload['next_page_uri']
+          return @version.domain.absolute_url(@payload['next_page_uri'])
+        end
+
+        nil
+      end
+
+      def get_instance(payload)
+        raise Gupshup::REST::GupshupError, 'Page.get_instance() must be implemented in the derived class'
+      end
+
+      def previous_page
+        return nil unless previous_page_url
+
+        response = @version.domain.request('GET', previous_page_url)
+
+        self.class.new(@version, response, @solution)
+      end
+
+      def next_page
+        return nil unless next_page_url
+
+        response = @version.domain.request('GET', next_page_url)
+
+        self.class.new(@version, response, @solution)
+      end
+
+      def each
+        @records.each do |record|
+          yield get_instance(record)
+        end
+      end
+
+      def to_s
+        '#<Page>'
+      end
+    end
+  end
+end

data/lib/gupshup-rb/framework/rest/resource.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Gupshup
+  module REST
+    class ListResource
+      def initialize(version)
+        @version = version
+      end
+    end
+
+    class InstanceContext
+      def initialize(version)
+        @version = version
+      end
+    end
+
+    class InstanceResource
+      def initialize(version)
+        @version = version
+      end
+    end
+  end
+end