justcall_ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3b8e75e621a9a8163f6267682f4982b3304d49d9db86dcfbc8e9485c7a8dbe75
+  data.tar.gz: 8ecac85c5fc52ce069671013cf83c43d90e9b99cbce783d65f68a094be2fd5b0
+SHA512:
+  metadata.gz: 0f8b5677142ae235b3533ad4c9ff5ae60b7e2d4ad1e34d12f8d99fdea0005569ce1b62ab4517093d773fbfb9a2c0719d8f36ee1bbe5541c3cab866018fd7c01d
+  data.tar.gz: 9b3dc176f846d070390f0e92170cf2c28e1fb2d432bd3ad030b18abd54a83ff8aa90dd95373d2532e32802e10720a93f53dcd0f6ae5d1bd9aa32f95ee7b53f57

data/.rubocop.yml

@@ -0,0 +1,128 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+
+# Layout cops
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/HashAlignment:
+  EnforcedLastArgumentHashStyle: ignore_implicit
+
+Layout/LineLength:
+  Max: 120
+  AutoCorrect: true
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/MultilineOperationIndentation:
+  Enabled: true
+  EnforcedStyle: indented
+
+Layout/ArgumentAlignment:
+  Enabled: true
+  EnforcedStyle: with_fixed_indentation
+
+# Lint cops
+Lint/AmbiguousBlockAssociation:
+  AllowedMethods: [proc, map]
+
+Lint/MissingSuper:
+  Enabled: false
+
+Lint/UriRegexp:
+  Enabled: false
+
+# Metrics cops
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+# Naming
+Naming/AccessorMethodName:
+  Enabled: false
+
+Naming/MemoizedInstanceVariableName:
+  Enabled: false
+
+Naming/VariableNumber:
+  Enabled: false
+
+# Style cops
+Style/FetchEnvVar:
+  Enabled: false
+
+Style/AccessorGrouping:
+  Enabled: false
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/FormatStringToken:
+  EnforcedStyle: template
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/GlobalVars:
+  AllowedVariables: [$redis]
+
+Style/Lambda:
+  EnforcedStyle: literal
+
+Style/MissingRespondToMissing:
+  Enabled: false
+
+Style/NumericPredicate:
+  AllowedMethods: ["=="]
+
+Style/Proc:
+  Enabled: false
+
+Style/RegexpLiteral:
+  AllowInnerSlashes: true
+
+Style/ReturnNil:
+  Enabled: true
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/SelectByRegexp:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: no_comma

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+## [0.1.0] - 2024-07-10
+
+The initial release. Provides all basic Ruby wrapper functionality for JustCall's V2 API.
+
+The V2 API currently includes the following endpoints:
+- Calls
+  - [List all calls](https://developer.justcall.io/reference/call_list)
+  - [Get a call](https://developer.justcall.io/reference/call_get)
+  - [Update a call](https://developer.justcall.io/reference/call_update)
+  - [Download a recording](https://developer.justcall.io/reference/call_recording_download)
+- SMS
+  - [List all texts](https://developer.justcall.io/reference/texts_list)
+  - [Get a text](https://developer.justcall.io/reference/texts_get)
+  - [Check reply](https://developer.justcall.io/reference/texts_checkreply)
+  - [Send SMS/MMS](https://developer.justcall.io/reference/texts_new)

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in justcall_ruby.gemspec
+gemspec
+
+group :development do
+  gem "minitest", "~> 5.0"
+  gem "rake", "~> 13.0"
+  gem "rubocop", "~> 1.21"
+end

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    justcall_ruby (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
+    minitest (5.24.1)
+    parallel (1.25.1)
+    parser (3.3.3.0)
+      ast (~> 2.4.1)
+      racc
+    racc (1.8.0)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    regexp_parser (2.9.2)
+    rexml (3.3.1)
+      strscan
+    rubocop (1.64.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    ruby-progressbar (1.13.0)
+    strscan (3.1.0)
+    unicode-display_width (2.5.0)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  justcall_ruby!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.4.10

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Jeffrey Dill
+
+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,37 @@
+# JustCall API - Ruby Wrapper
+
+## Installation
+Add this line to your application's Gemfile:
+```
+gem 'justcall_ruby'
+```
+
+And then execute:
+```
+$ bundle
+```
+
+Or install it locally using:
+```
+$ gem install justcall_ruby
+```
+
+## Usage
+
+### Documentation
+The full documentation is located here: http://www.rubydoc.info/gems/justcall_ruby
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/leadsimple/justcall_ruby.
+
+To contribute code changes:
+1. Fork it ( https://github.com/leadsimple/justcall_ruby/fork )
+1. Create your feature branch (`git checkout -b my-new-feature`)
+1. Commit your changes (`git commit -am 'Add some feature'`)
+1. Push to the branch (`git push origin my-new-feature`)
+1. Create a new Pull Request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/justcall_ruby.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "justcall_ruby/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "justcall_ruby"
+  spec.version = JustCall::VERSION
+  spec.authors = ["Jeffrey Dill"]
+  spec.email = ["jeffdill2@gmail.com"]
+  spec.summary = "A simple Ruby wrapper for the JustCall REST API"
+  spec.homepage = "https://github.com/leadsimple/justcall_ruby"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = 'true'
+
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ .git .circleci])
+    end
+  end
+
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/justcall_ruby/api.rb

@@ -0,0 +1,71 @@
+require 'net/http'
+
+module JustCall
+  module API
+    ROOT_URL = 'https://api.justcall.io/v2'.freeze
+    USER_AGENT = "JustCallRubyGem/#{JustCall::VERSION}".freeze
+
+    private
+
+    def get_request(client:, endpoint:)
+      request = Net::HTTP::Get.new(request_url(endpoint))
+
+      submit_request(client: client, request: request)
+    end
+
+    def post_request(client:, endpoint:, data: {})
+      request = Net::HTTP::Post.new(request_url(endpoint))
+
+      submit_request(client: client, request: request, data: data)
+    end
+
+    def put_request(client:, endpoint:, data: {})
+      request = Net::HTTP::Put.new(request_url(endpoint))
+
+      submit_request(client: client, request: request, data: data)
+    end
+
+    def delete_request(client:, endpoint:)
+      request = Net::HTTP::Delete.new(request_url(endpoint))
+
+      submit_request(client: client, request: request)
+    end
+
+    def submit_request(client:, request:, data: {})
+      set_request_headers(client: client, request: request)
+
+      uri = URI(request.path)
+      http = Net::HTTP.new(uri.host, uri.port)
+
+      request.body = data.is_a?(Hash) ? data.to_json : data if data.any?
+      http.use_ssl = true
+      http.set_debug_output($stdout) if JustCall.config.full_debug?
+
+      response = http.start { |h| h.request(request) }
+
+      JustCall::Response.new(response)
+    end
+
+    def set_request_headers(client:, request:)
+      request['Accept'] = 'application/json'
+      request['Authorization'] = [client.api_key, client.api_secret].join(':')
+      request['Content-Type'] = 'application/json'
+      request['User-Agent'] = USER_AGENT
+    end
+
+    def request_url(endpoint)
+      [ROOT_URL, endpoint].join('/')
+    end
+
+    def standardize_body_data(submitted_attrs:, permitted_attrs:)
+      submitted_attrs = submitted_attrs.deep_transform_keys(&:to_sym)
+      permitted_attrs = submitted_attrs.select! { |k, _| permitted_attrs.include?(k) } || submitted_attrs
+
+      permitted_attrs.deep_transform_keys { |k| k.to_s.camelize(:lower) }
+    end
+
+    def convert_params_to_request_query(params)
+      params&.map { |k, v| [k.to_s.camelize(:lower), v].join('=') }&.join('&')
+    end
+  end
+end

data/lib/justcall_ruby/base.rb

@@ -0,0 +1,27 @@
+module JustCall
+  class Base
+    protected
+
+    def requires!(*args)
+      self.class.requires!(*args)
+    end
+
+    class << self
+      def requires!(hash, *params)
+        params.each do |param|
+          if param.is_a?(Array)
+            raise ArgumentError, "Missing required parameter: #{param.first}" unless hash.key?(param.first)
+
+            valid_options = param[1..]
+
+            unless valid_options.include?(hash[param.first])
+              raise ArgumentError, "Parameter: #{param.first} must be one of: #{valid_options.join(', ')}"
+            end
+          else
+            raise ArgumentError, "Missing required parameter: #{param}" unless hash.key?(param)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/justcall_ruby/call.rb

@@ -0,0 +1,70 @@
+require 'justcall_ruby/api'
+
+module JustCall
+  class Call < Base
+    include JustCall::API
+
+    LIST_ATTRS = {
+      permitted: %i[
+        fetch_queue_data fetch_iq_data page per_page sort order from_datetime to_datetime
+        contact_number justcall_number agent_id ivr_digit call_direction call_type
+      ].freeze,
+    }.freeze
+
+    FETCH_ATTRS = {
+      permitted: %i[fetch_queue_data fetch_iq_data].freeze,
+    }.freeze
+
+    UPDATE_ATTRS = {
+      permitted: %i[notes disposition_code rating].freeze,
+    }.freeze
+
+    CHECK_REPLY_ATTRS = {
+      permitted: %i[contact_number justcall_number].freeze,
+      required: %i[contact_number].freeze,
+    }.freeze
+
+    SEND_ATTRS = {
+      permitted: %i[justcall_number body contact_number media_url restrict_once].freeze,
+      required: %i[justcall_number body contact_number].freeze,
+    }.freeze
+
+    ENDPOINTS = {
+      list: "calls?%s".freeze,
+      fetch: "calls/%s?%s".freeze,
+      update: "calls/%s".freeze,
+      download_recording: "calls/%s/recording/download".freeze,
+    }.freeze
+
+    def initialize(client:)
+      @client = client
+    end
+
+    def list(params = {})
+      params = standardize_body_data(submitted_attrs: params, permitted_attrs: LIST_ATTRS[:permitted])
+      endpoint = ENDPOINTS[:list] % convert_params_to_request_query(params)
+
+      get_request(client: @client, endpoint: endpoint)
+    end
+
+    def fetch(call_id, params = {})
+      params = standardize_body_data(submitted_attrs: params, permitted_attrs: FETCH_ATTRS[:permitted])
+      endpoint = ENDPOINTS[:fetch] % [call_id, convert_params_to_request_query(params)] # rubocop:disable Style/FormatString
+
+      get_request(client: @client, endpoint: endpoint)
+    end
+
+    def update(call_id, params)
+      endpoint = ENDPOINTS[:update] % call_id
+      params = standardize_body_data(submitted_attrs: params, permitted_attrs: UPDATE_ATTRS[:permitted])
+
+      put_request(client: @client, endpoint: endpoint, data: params)
+    end
+
+    def download_recording(call_id)
+      endpoint = ENDPOINTS[:download_recording] % call_id
+
+      get_request(client: @client, endpoint: endpoint)
+    end
+  end
+end

data/lib/justcall_ruby/client.rb

@@ -0,0 +1,24 @@
+require 'justcall_ruby/api'
+require 'justcall_ruby/call'
+require 'justcall_ruby/sms'
+
+module JustCall
+  class Client
+    include JustCall::API
+
+    attr_reader :api_key, :api_secret
+
+    def initialize(api_key:, api_secret:)
+      @api_key = api_key
+      @api_secret = api_secret
+    end
+
+    def call
+      @call ||= JustCall::Call.new(client: self)
+    end
+
+    def sms
+      @sms ||= JustCall::SMS.new(client: self)
+    end
+  end
+end

data/lib/justcall_ruby/error.rb

@@ -0,0 +1,9 @@
+module JustCall
+  class Error < StandardError
+    class NoContent < JustCall::Error; end
+    class NotAuthorized < JustCall::Error; end
+    class NotFound < JustCall::Error; end
+    class RequestError < JustCall::Error; end
+    class TimeoutError < JustCall::Error; end
+  end
+end

data/lib/justcall_ruby/response.rb

@@ -0,0 +1,47 @@
+module JustCall
+  class Response
+    attr_reader :body, :response, :sucess
+
+    def initialize(response)
+      @response = response
+
+      case @response
+      when Net::HTTPUnauthorized
+        raise JustCall::Error::NotAuthorized, @response.body
+      when Net::HTTPNotFound
+        raise JustCall::Error::NotFound, @response.body
+      when Net::HTTPOK, Net::HTTPSuccess, Net::HTTPNoContent, Net::HTTPCreated
+        @success = true
+        body = (JSON.parse(@response.body) if @response.body.present?)
+        @body =
+          if body.is_a?(Hash)
+            body.deep_symbolize_keys
+          elsif body.is_a?(Array)
+            body.map(&:deep_symbolize_keys)
+          end
+      else
+        puts "-- DEBUG: #{self}: RequestError: #{@response.inspect}" if JustCall.config.full_debug?
+
+        error_message = begin
+          JSON.parse(@response.body)['errors'].map { |error| error['message'].chomp('.') }.join('. ')
+        rescue StandardError
+          [@response.message, @response.body].reject(&:blank?).join(" | ")
+        end
+
+        raise JustCall::Error::RequestError, error_message
+      end
+    end
+
+    def [](key)
+      body[key]
+    end
+
+    def fetch(key)
+      body.fetch(key)
+    end
+
+    def success?
+      !!success
+    end
+  end
+end

data/lib/justcall_ruby/sms.rb

@@ -0,0 +1,66 @@
+require 'justcall_ruby/api'
+
+module JustCall
+  class SMS < Base
+    include JustCall::API
+
+    LIST_ATTRS = {
+      permitted: %i[
+        page per_page sort order from_datetime to_datetime contact_number
+        justcall_number sms_direction sms_content last_sms_id_fetched
+      ].freeze,
+    }.freeze
+
+    CHECK_REPLY_ATTRS = {
+      permitted: %i[contact_number justcall_number].freeze,
+      required: %i[contact_number].freeze,
+    }.freeze
+
+    SEND_ATTRS = {
+      permitted: %i[justcall_number body contact_number media_url restrict_once].freeze,
+      required: %i[justcall_number body contact_number].freeze,
+    }.freeze
+
+    ENDPOINTS = {
+      list: "texts?%s".freeze,
+      fetch: "texts/%s".freeze,
+      check_reply: "texts/checkreply".freeze,
+      send: "texts/new".freeze,
+    }.freeze
+
+    def initialize(client:)
+      @client = client
+    end
+
+    def list(params = {})
+      params = standardize_body_data(submitted_attrs: params, permitted_attrs: LIST_ATTRS[:permitted])
+      endpoint = ENDPOINTS[:list] % convert_params_to_request_query(params)
+
+      get_request(client: @client, endpoint: endpoint)
+    end
+
+    def fetch(sms_id)
+      endpoint = ENDPOINTS[:fetch] % sms_id
+
+      get_request(client: @client, endpoint: endpoint)
+    end
+
+    def check_reply(params)
+      requires!(params, *CHECK_REPLY_ATTRS[:required])
+
+      endpoint = ENDPOINTS[:check_reply]
+      params = standardize_body_data(submitted_attrs: params, permitted_attrs: CHECK_REPLY_ATTRS[:permitted])
+
+      post_request(client: @client, endpoint: endpoint, data: params)
+    end
+
+    def send(params)
+      requires!(params, *SEND_ATTRS[:required])
+
+      endpoint = ENDPOINTS[:send]
+      params = standardize_body_data(submitted_attrs: params, permitted_attrs: SEND_ATTRS[:permitted])
+
+      post_request(client: @client, endpoint: endpoint, data: params)
+    end
+  end
+end

data/lib/justcall_ruby/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module JustCall
+  VERSION = "0.1.0"
+end

data/lib/justcall_ruby.rb

@@ -0,0 +1,29 @@
+require 'justcall_ruby/base'
+require 'justcall_ruby/version'
+
+require 'justcall_ruby/api'
+require 'justcall_ruby/call'
+require 'justcall_ruby/client'
+require 'justcall_ruby/error'
+require 'justcall_ruby/response'
+require 'justcall_ruby/sms'
+
+module JustCall
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  def self.configure
+    yield(config)
+  end
+
+  class Configuration
+    attr_accessor :full_debug
+
+    alias full_debug? full_debug
+
+    def initialize
+      @full_debug = false
+    end
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: justcall_ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeffrey Dill
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-07-11 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- jeffdill2@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- justcall_ruby.gemspec
+- lib/justcall_ruby.rb
+- lib/justcall_ruby/api.rb
+- lib/justcall_ruby/base.rb
+- lib/justcall_ruby/call.rb
+- lib/justcall_ruby/client.rb
+- lib/justcall_ruby/error.rb
+- lib/justcall_ruby/response.rb
+- lib/justcall_ruby/sms.rb
+- lib/justcall_ruby/version.rb
+homepage: https://github.com/leadsimple/justcall_ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/leadsimple/justcall_ruby
+  source_code_uri: https://github.com/leadsimple/justcall_ruby
+  changelog_uri: https://github.com/leadsimple/justcall_ruby/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: A simple Ruby wrapper for the JustCall REST API
+test_files: []