cloud-waba-ruby-client 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89437f3bd0c514a2d35343a46891931087d376c76de5de276cb3e90de87ced84
-  data.tar.gz: 2d9e434046bc4e996746b2e43547433159a39e8430b197966e3871985a12e1c5
+  metadata.gz: add418afadc7db2c4e164bc742a67bb82b5b372d7bf84f956fbc8d7c2d948930
+  data.tar.gz: c210daa37769103a78c3f290d75e5af35cc92104b1f2b1b6f21918d24a2e8cac
 SHA512:
-  metadata.gz: fa1590c643341ad725aa7b40a7f3bb5c1279ef48214982f305b174cd13616fc4546f7b9cec6ae265b32c0c94492bea6015bb89649cd6e20d9cc8f746cded445c
-  data.tar.gz: f7308f3c128cbe5c3777cf02b1e5f4ee808e1bc127ae3b8aa26ad44a77ae370231f1c3f5428405b41c7cbf0478a4d6baa0b5e292b59cd0beca3601fc8f5ff326
+  metadata.gz: f1c12beadeedf7f0fa3b8268b9b8d548ebb362c11e1626b88a4b7de3ef28f55a131c89dbb2d1c3f894e68c8485177fa7b490927ddb82cc87ba5475b4b17465d2
+  data.tar.gz: 43de35076e075ceb5eb08307b975f78326d6a7ab97bc89bf8ce07498319be284ec777548e6ec6023b36178f8166c463c91639ba7c71dc7e474d8e0b60fb3c268

data/.byebug_history

@@ -0,0 +1,15 @@
+c
+phone_number_id
+c
+C
+c
+client.config
+client.config.methods
+client.config.keys
+ENV["CLOUD_API_ACCESS_TOKEN"]
+ENV
+client.config.access_token
+client.config
+c
+client.config
+client

data/Gemfile

@@ -1,2 +1,6 @@
 source "https://rubygems.org"
-gemspec
+gemspec
+
+group :test do
+  gem 'byebug', '~> 9.0', '>= 9.0.5'
+end

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    cloud-waba-ruby-client (0.0.0)
+    cloud-waba-ruby-client (0.0.2)
       dotenv (~> 2.8.0)
-      http (~> 4.0.0)
+      http (~> 4.4.1)
       sorbet-runtime (~> 0.5.1)
 
 GEM
@@ -18,17 +18,23 @@ GEM
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
     dotenv (2.8.1)
+    ffi (1.15.5)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
     hashdiff (1.0.1)
-    http (4.0.5)
+    http (4.4.1)
       addressable (~> 2.3)
       http-cookie (~> 1.0)
-      http-form_data (~> 2.0)
-      http_parser.rb (~> 0.6.0)
+      http-form_data (~> 2.2)
+      http-parser (~> 1.2.0)
     http-cookie (1.0.5)
       domain_name (~> 0.5)
     http-form_data (2.3.0)
-    http_parser.rb (0.6.0)
+    http-parser (1.2.3)
+      ffi-compiler (>= 1.0, < 2.0)
     public_suffix (4.0.7)
+    rake (13.0.6)
     rexml (3.2.6)
     rspec (3.4.0)
       rspec-core (~> 3.4.0)
@@ -62,8 +68,7 @@ DEPENDENCIES
   byebug (~> 9.0, >= 9.0.5)
   cloud-waba-ruby-client!
   rspec (~> 3.4.0)
-  sorbet
-  sorbet-runtime
+  sorbet (~> 0.5.1)
   webmock (~> 3.17.0)
 
 BUNDLED WITH

data/README.md

@@ -23,12 +23,36 @@ gem install cloud-waba-ruby-client
 ```
 
 ## Setup
-1. Make sure you have
+1. Make sure you have:
   - Meta business app
   - WhatsApp Business account
   - A phone number added to your WhatsApp business account
   - Meta developer app
-2. Add following environment variables to your `.env` file:
+### Initiating clients using parameters
+```ruby
+require "cloud_waba/client"
+client_1 = CloudWaba::Client.new(
+  app_id: param_app_id_1,
+  app_secret: param_app_secret_1,
+  phone_number_id: param_phone_number_id_1,
+  business_account_id: param_business_account_id_1,
+  access_token: param_access_token_1,
+  api_version: param_api_version_1
+)
+
+client_2 = CloudWaba::Client.new(
+  app_id: param_app_id_2,
+  app_secret: param_app_secret_2,
+  phone_number_id: param_phone_number_id_2,
+  business_account_id: param_business_account_id_2,
+  access_token: param_access_token_2,
+  api_version: param_api_version_2
+)
+
+# Do somethingn with the clients
+```
+### Initiating client using Env variables
+Add following environment variables to your `.env` file:
   ```shell
   WA_BASE_URL=https://graph.facebook.com
   CLOUD_API_VERSION=v16.0
@@ -39,7 +63,10 @@ gem install cloud-waba-ruby-client
   CLOUD_API_ACCESS_TOKEN=
   ```
 Fill credentials for your meta developer app, business account and phone number ids.
-
+```ruby
+require "cloud_waba/client"
+client = CloudWaba::Client.new # If no params provided, configuration will fallback to env variables
+```
 ## Usage
 ### Sending template message
 ```ruby

data/cloud-waba-ruby-client.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = "cloud-waba-ruby-client"
-  s.version     = "0.0.2"
+  s.version     = "0.0.3"
   s.summary     = "Cloud Waba Client for Ruby."
   s.description = "A simple API wrapper for Cloud Whatsapp Business API"
   s.authors     = ["Ahmed Bassell"]
@@ -10,6 +10,7 @@ Gem::Specification.new do |s|
   s.homepage    =
     "https://rubygems.org/gems/cloud_waba"
   s.license       = "MIT"
+  s.required_ruby_version = '>= 2.5.3'
   
   # Runtime dependencies
   s.add_dependency 'dotenv', '~>2.8.0' # env variable
@@ -18,7 +19,6 @@ Gem::Specification.new do |s|
   # Development dependencies
   s.add_development_dependency "rspec", '~>3.4.0' # testing
   s.add_development_dependency 'webmock', '~>3.17.0'
-  s.add_development_dependency 'byebug', '~> 9.0', '>= 9.0.5'
   s.add_development_dependency 'sorbet', '~> 0.5.1'
   s.add_runtime_dependency 'sorbet-runtime', '~>0.5.1'
 end

data/lib/cloud_waba/client.rb

@@ -47,8 +47,34 @@ module CloudWaba
     extend ::T::Sig
     extend ::T::Helpers
 
-    def initialize
-      @config = ::CloudWaba::Utils.import_config
+    attr_reader :config
+
+    sig do
+      params(
+        app_id: ::T.nilable(::String),
+        app_secret: ::T.nilable(::String),
+        phone_number_id: ::T.nilable(::String),
+        business_account_id: ::T.nilable(::String),
+        access_token: ::T.nilable(::String),
+        api_version: ::T.nilable(::String)
+      ).void
+    end
+    def initialize(
+      app_id: nil,
+      app_secret: nil,
+      phone_number_id: nil,
+      business_account_id: nil,
+      access_token: nil,
+      api_version: nil
+    )
+      @config = ::CloudWaba::Utils.import_config(
+        app_id: app_id,
+        app_secret: app_secret,
+        phone_number_id: phone_number_id,
+        business_account_id: business_account_id,
+        access_token: access_token,
+        api_version: api_version
+      )
     end
 
     def messages

data/lib/cloud_waba/utils.rb

@@ -6,30 +6,37 @@ module CloudWaba
     extend ::T::Sig
     extend ::T::Helpers
 
-    sig { returns(::CloudWaba::Models::Config) }
-    def self.import_config
+    sig do
+      params(
+        app_id: ::T.nilable(::String),
+        app_secret: ::T.nilable(::String),
+        phone_number_id: ::T.nilable(::String),
+        business_account_id: ::T.nilable(::String),
+        access_token: ::T.nilable(::String),
+        api_version: ::T.nilable(::String)
+      ).returns(::CloudWaba::Models::Config)
+    end
+    def self.import_config(app_id:, app_secret:, phone_number_id:, business_account_id:, access_token:, api_version:)
       Dotenv.load
       validate_config!
 
       base_url = ENV.fetch("WA_BASE_URL", "https://graph.facebook.com")
-      app_id = ENV.fetch("M4D_APP_ID", "")
-      app_secret = ENV.fetch("M4D_APP_SECRET", "")
-      phone_number_id = ENV.fetch("WA_PHONE_NUMBER_ID", "")
-      business_account_id = ENV.fetch("WA_BUSINESS_ACCOUNT_ID", "")
-      access_token = ENV.fetch("CLOUD_API_ACCESS_TOKEN", "")
-      api_version = ENV.fetch("CLOUD_API_VERSION", "v16.0")
+      app_id = app_id || ENV.fetch("M4D_APP_ID", "")
+      app_secret = app_secret || ENV.fetch("M4D_APP_SECRET", "")
+      phone_number_id = phone_number_id || ENV.fetch("WA_PHONE_NUMBER_ID", "")
+      business_account_id = business_account_id || ENV.fetch("WA_BUSINESS_ACCOUNT_ID", "")
+      access_token = access_token || ENV.fetch("CLOUD_API_ACCESS_TOKEN", "")
+      api_version = api_version || ENV.fetch("CLOUD_API_VERSION", "v16.0")
 
-      config = ::CloudWaba::Models::Config.new(
+      ::CloudWaba::Models::Config.new(
         base_url: base_url,
         app_id: app_id,
         app_secret: app_secret,
         phone_number_id: phone_number_id,
         business_account_id: business_account_id,
         api_version: api_version,
-        access_token: access_token,
+        access_token: access_token
       )
-
-      config
     end
 
     private

data/spec/cloud_waba/client_spec.rb

@@ -0,0 +1,96 @@
+require 'spec_helper'
+
+describe ::CloudWaba::Client do
+  let(:env_access_token) { ENV["CLOUD_API_ACCESS_TOKEN"] }
+  let(:env_api_version) { ENV["CLOUD_API_VERSION"] }
+  let(:env_app_id) { ENV["M4D_APP_ID"] }
+  let(:env_app_secret) { ENV["M4D_APP_SECRET"] }
+  let(:env_base_url) { ENV["WA_BASE_URL"] }
+  let(:env_business_account_id) { ENV["WA_BUSINESS_ACCOUNT_ID"] }
+  let(:env_phone_number_id) { ENV["WA_PHONE_NUMBER_ID"] }
+
+  let(:param_access_token) { "CLOUD_API_ACCESS_TOKEN_PARAM_VALUE" }
+  let(:param_api_version) { "CLOUD_API_VERSION_PARAM_VALUE" }
+  let(:param_app_id) { "M4D_APP_ID_PARAM_VALUE" }
+  let(:param_app_secret) { "M4D_APP_SECRET_PARAM_VALUE" }
+  let(:param_business_account_id) { "WA_BUSINESS_ACCOUNT_ID_PARAM_VALUE" }
+  let(:param_phone_number_id) { "WA_PHONE_NUMBER_ID_PARAM_VALUE" }
+
+  before do
+    # Set env variables for testing
+    ENV["CLOUD_API_ACCESS_TOKEN"] = "CLOUD_API_ACCESS_TOKEN_VALUE"
+    ENV["CLOUD_API_VERSION"] = "CLOUD_API_VERSION_VALUE"
+    ENV["M4D_APP_ID"] = "M4D_APP_ID_VALUE"
+    ENV["M4D_APP_SECRET"] = "M4D_APP_SECRET_VALUE"
+    ENV["WA_BASE_URL"] = "WA_BASE_URL_VALUE"
+    ENV["WA_BUSINESS_ACCOUNT_ID"] = "WA_BUSINESS_ACCOUNT_ID_VALUE"
+    ENV["WA_PHONE_NUMBER_ID"] = "WA_PHONE_NUMBER_ID_VALUE"
+  end
+
+  context "When init new client instance using env variables" do
+    it "Should read configuration from environment variables" do
+      client = described_class.new
+
+      expect(client.config.access_token).to eq(env_access_token)
+      expect(client.config.api_version).to eq(env_api_version)
+      expect(client.config.app_id).to eq(env_app_id)
+      expect(client.config.app_secret).to eq(env_app_secret)
+      expect(client.config.base_url).to eq(env_base_url)
+      expect(client.config.business_account_id).to eq(env_business_account_id)
+      expect(client.config.phone_number_id).to eq(env_phone_number_id)
+    end
+  end
+
+  context "When init new client instance using params" do
+    it "Should read configuration from parameters if provided" do
+      client = described_class.new(
+        app_id: param_app_id,
+        app_secret: param_app_secret,
+        phone_number_id: param_phone_number_id,
+        business_account_id: param_business_account_id,
+        access_token: param_access_token,
+        api_version: param_api_version
+      )
+
+      expect(client.config.access_token).to eq(param_access_token)
+      expect(client.config.access_token).not_to eq(env_access_token)
+
+      expect(client.config.api_version).to eq(param_api_version)
+      expect(client.config.api_version).not_to eq(env_api_version)
+
+      expect(client.config.app_id).to eq(param_app_id)
+      expect(client.config.app_id).not_to eq(env_app_id)
+
+      expect(client.config.app_secret).to eq(param_app_secret)
+      expect(client.config.app_secret).not_to eq(env_app_secret)
+
+      expect(client.config.business_account_id).to eq(param_business_account_id)
+      expect(client.config.business_account_id).not_to eq(env_business_account_id)
+
+      expect(client.config.phone_number_id).to eq(param_phone_number_id)
+      expect(client.config.phone_number_id).not_to eq(env_phone_number_id)
+    end
+  end
+
+  context "When multiple clients co-exist" do
+    it "Should have different configurations per client" do
+      client_1 = described_class.new
+      client_2 = described_class.new(
+        app_id: param_app_id,
+        app_secret: param_app_secret,
+        phone_number_id: param_phone_number_id,
+        business_account_id: param_business_account_id,
+        access_token: param_access_token,
+        api_version: param_api_version
+      )
+
+      expect(client_1).not_to eq(client_2)
+      expect(client_1.config.access_token).not_to eq(client_2.config.access_token)
+      expect(client_1.config.api_version).not_to eq(client_2.config.api_version)
+      expect(client_1.config.app_id).not_to eq(client_2.config.app_id)
+      expect(client_1.config.app_secret).not_to eq(client_2.config.app_secret)
+      expect(client_1.config.business_account_id).not_to eq(client_2.config.business_account_id)
+      expect(client_1.config.phone_number_id).not_to eq(client_2.config.phone_number_id)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,9 +1,10 @@
 require 'bundler/setup'
 require 'dotenv/load'
+require 'byebug'
 
 Bundler.setup
 
-require 'cloud_waba' # and any other gems you need
+require 'cloud_waba/client' # and any other gems you need
 
 RSpec.configure do |config|
   # some (optional) config here

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloud-waba-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Ahmed Bassell
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-04 00:00:00.000000000 Z
+date: 2023-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -66,26 +66,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.17.0
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '9.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 9.0.5
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '9.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 9.0.5
 - !ruby/object:Gem::Dependency
   name: sorbet
   requirement: !ruby/object:Gem::Requirement
@@ -120,6 +100,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".byebug_history"
 - ".env.example"
 - ".gitignore"
 - ".rspec"
@@ -162,7 +143,7 @@ files:
 - lib/cloud_waba/models/templates/message_template.rb
 - lib/cloud_waba/models/templates/response.rb
 - lib/cloud_waba/utils.rb
-- spec/cloud_waba_spec.rb
+- spec/cloud_waba/client_spec.rb
 - spec/spec_helper.rb
 homepage: https://rubygems.org/gems/cloud_waba
 licenses:
@@ -176,7 +157,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/spec/cloud_waba_spec.rb

@@ -1,4 +0,0 @@
-require 'spec_helper'
-describe CloudWaba do
-  pending "write it"
-end