wa_cloud_api 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '07686d03b3255beef59f09b95b3a7d8f066060cef6efe40daabfdac2c059fe70'
-  data.tar.gz: b5abb355304203621971e7379f238b4ce9b3e6140145ddaa5ac5fabff6890565
+  metadata.gz: 84d622cdbb39eec1fe5984e5d6f747d5d471c771714f7d8883d5e36f021ed582
+  data.tar.gz: f70748309ebe1642c507f4e043c623123233f0353c960aae268807dfe1448508
 SHA512:
-  metadata.gz: cee34746b53e2bb089a03caac5d2607020a661916897a17624fa353980023c8938718006623777e77cc44a5e0fbaf5aff40dd8c02492eab1bc5884e53940a37c
-  data.tar.gz: 3c95163da97ee845e7661167b1ade0ff8d04f3929f6e5dc1399486b8a4b1faede4ee39ba2103cfbba208797f305fa6441ca7a0d0a0dd2e951257d585a9a972e4
+  metadata.gz: 5a321a7ea5599a9c69c1218abf5d66c68960290cba9d2c094598acd2811f4946f5603fc42fb97d2a479706bcc96e95b1511a602015d30b485a13e6c3a22d3419
+  data.tar.gz: 3c3e916a74fc2af0d3f0608390fb1ebe0fe87d5d9f985deb9fe2212ddcba7cc5fc356aedb62a550365f2e22f22746d151ebc34fb5b68d1ad00435e523a35dd59

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 RAJANA VENKATA SURYA TEJA
+
+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

@@ -1,35 +1,105 @@
 # WaCloudApi
 
-TODO: Delete this and the text below, and describe your gem
+WaCloudApi is a ruby gem that provides a convinient way to interact with Whatsapp Cloud API allowing developer to integrate Whatsapp messaging capabilities into Ruby / Rails applications.
 
-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/wa_cloud_api`. To experiment with that code, run `bin/console` for an interactive prompt.
+# Installation
+Install the gem and add to the application's Gemfile by executing:
 
-## Installation
+```bash
+$ bundle add wa_cloud_api
+```
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+If bundler is not being used to manage dependencies, install the gem by executing:
 
-Install the gem and add to the application's Gemfile by executing:
+```bash
+$ gem install wa_cloud_api
+```
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+# Usage
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+### Configuration
+
+Before using the gem, you need to configure it with your WhatsApp Cloud API credentials. You can do this by using the following code:
+
+```ruby
+require 'wa_cloud_api'
+
+WaCloudApi.configure do |config| 
+  config.phone_number_id = 'your_phone_number_id'
+  config.token = 'your_token'
+end
+```
+
+### Features
+
+- Text Message
+- Reaction
+- Location
+
+### Text Message
+
+To send a text message to a phone number. 
+
+Parameters
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+1. `to`: (Required) The phone number of the recipient. It should be in international format
+2. `body`: (Required) The actual text message you want to send
+3. `preview_url`: (Optional) A boolean parameter whether a URL preview should be generated for the links in the message. By default it is set to false
 
-## Usage
+```ruby
+WaCloudApi::Message::Text.new(
+  to: 'recipient_phone_number ', 
+  body: 'This is a test message',
+).deliver
+```
 
-TODO: Write usage instructions here
+### Reaction
+
+To send a reaction to a message
+
+Parameters
+
+1. `to`: (Required) The phone number of the recipient. It should be in international format
+2. `message_id`: (required) The message id you want to react
+3. `emoji`: (required) The emoji you want to react
+
+```ruby
+WaCloudApi::Message::Reaction.new(
+  to: 'recipient_phone_number',
+  message_id: 'whatsapp_message_id',
+  emoji: 'emoji'
+).deliver
+```
+
+### Location
+
+To send a location to a phone number
+
+Parameters
+
+1. `to`: (Required) The phone number of the recipient. It should be in international format
+2. `longitude`: (Required) Longitude of the location
+3. `latitude`: (Required) Latitude of the location
+4. `name`: (Optional) Name of the location
+5. `address`: (Optional) Address of the location
+
+```ruby
+WaCloudApi::Message::Location.new(
+  to: 'recipient_phone_number',
+  longitude: 'longitude',
+  latitude: 'latitude',
+  name: 'location_name',
+  address: 'location_address'
+).deliver
+```
 
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. 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).
+To install this gem onto your local machine, run `bundle exec rake install`. 
 
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/wa_cloud_api. 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]/wa_cloud_api/blob/main/CODE_OF_CONDUCT.md).
 
-## Code of Conduct
+## Contributing
 
-Everyone interacting in the WaCloudApi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/wa_cloud_api/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/rvs-teja/wa_cloud_api. 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/rvs-teja/wa_cloud_api/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,4 +1,10 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
 task default: %i[]
+
+desc 'Run test'
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/lib/wa_cloud_api/client.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module WaCloudApi
+  class Client
+    def deliver(_params)
+      validate_configuration
+    end
+
+    private
+
+    def validate_configuration
+      raise ArgumentError, 'Configuration is not set' if WaCloudApi.configuration.nil?
+
+      WaCloudApi.configuration.valid?
+    end
+  end
+end

data/lib/wa_cloud_api/configuration.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module WaCloudApi
+  class Configuration
+    attr_accessor :phone_number_id, :token
+
+    MANDATORY_ATTRIBUTES = %i[phone_number_id token].freeze
+
+    def initialize
+      @missing_params = []
+    end
+
+    def valid?
+      MANDATORY_ATTRIBUTES.each do |attribute|
+        @missing_params << attribute unless instance_variable_defined?("@#{attribute}")
+      end
+
+      raise ArgumentError, "#{@missing_params.join(', ')} are not set in configuration" unless @missing_params.empty?
+
+      true
+    end
+  end
+end

data/lib/wa_cloud_api/message/base.rb

@@ -0,0 +1,24 @@
+module WaCloudApi
+  module Message
+    class Base
+      attr_accessor :messaging_product, :recipient_type, :to, :type
+
+      def initialize(to:, type:)
+        @messaging_product = 'whatsapp'
+        @recipient_type = 'individual'
+        @to = to
+        @type = type
+      end
+
+      def deliver
+        Service.deliver(params: request_params)
+      end
+
+      private
+
+      def request_params
+        raise NotImplementedError, 'Should be implemented by child class'
+      end
+    end
+  end
+end

data/lib/wa_cloud_api/message/client.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'json'
+
+require_relative 'response'
+require_relative '../client'
+
+module WaCloudApi
+  module Message
+    class Client < WaCloudApi::Client
+      def self.deliver(params:)
+        response = new.deliver(params)
+        Response.new(response.status, response.body)
+      end
+
+      def deliver(params)
+        super
+        conn.post do |req|
+          req.body = params.to_json
+        end
+      end
+
+      private
+
+      def url
+        "https://graph.facebook.com/v18.0/#{WaCloudApi.configuration.phone_number_id}/messages"
+      end
+
+      def conn
+        @conn ||= Faraday.new(url: url) do |faraday|
+          faraday.adapter Faraday.default_adapter
+          faraday.headers['Authorization'] = "Bearer #{WaCloudApi.configuration.token}"
+          faraday.headers['Content-Type'] = 'application/json'
+        end
+      end
+    end
+  end
+end

data/lib/wa_cloud_api/message/error.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module WaCloudApi
+  module Message
+    Error = Struct.new(:message, :type, :code, :fbtrace_id, :error_subcode, :error_data, keyword_init: true) do
+
+      def handle_error
+        raise WaCloudApi::Error, error_message
+      end
+
+      private
+
+      def error_message
+        error_data&.dig(:details) || message
+      end
+    end
+  end
+end

data/lib/wa_cloud_api/message/location.rb

@@ -0,0 +1,33 @@
+require_relative 'base'
+
+module WaCloudApi
+  module Message
+    class Location < Base
+      attr_accessor :longitude, :latitude, :name, :address
+
+      def initialize(to:, longitude:, latitude:, name: nil, address: nil)
+        @longitude = longitude
+        @latitude = latitude
+        @name = name
+        @address = address
+        super(to: to, type: 'location')
+      end
+
+      private
+
+      def request_params
+        {
+          messaging_product: messaging_product,
+          to: to,
+          type: type,
+          location: {
+            longitude: longitude,
+            latitude: latitude,
+            name: name,
+            address: address
+          }
+        }
+      end
+    end
+  end
+end

data/lib/wa_cloud_api/message/reaction.rb

@@ -0,0 +1,32 @@
+require 'json'
+
+require_relative 'base'
+
+module WaCloudApi
+  module Message
+    class Reaction < Base
+      attr_accessor :message_id, :emoji
+
+      def initialize(to:, message_id:, emoji:)
+        @message_id = message_id
+        @emoji = JSON.parse("\"#{emoji}\"").encode('utf-8')
+        super(to: to, type: 'reaction')
+      end
+
+      private
+
+      def request_params
+        {
+          messaging_product: messaging_product,
+          recipient_type: recipient_type,
+          to: to,
+          type: type,
+          "reaction": {
+            "message_id": message_id,
+            "emoji": emoji
+          }
+        }
+      end
+    end
+  end
+end

data/lib/wa_cloud_api/message/response.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module WaCloudApi
+  module Message
+    class Response
+      Contact = Struct.new(:input, :wa_id, keyword_init: true)
+      Message = Struct.new(:id, keyword_init: true)
+
+      attr_accessor :status, :data
+
+      def initialize(status, response)
+        @status = status.to_i
+        @data = convert_keys_to_symbols(JSON.parse(response))
+      end
+
+      def ok?
+        status == 200
+      end
+
+      def contacts
+        data[:contacts]&.map(&Contact.method(:new)) || []
+      end
+
+      def messages
+        data[:messages]&.map(&Message.method(:new)) || []
+      end
+
+      private
+
+      def convert_keys_to_symbols(obj)
+        case obj
+        when Hash
+          obj.transform_keys(&:to_sym)
+             .transform_values { |value| convert_keys_to_symbols(value) }
+        when Array
+          obj.map { |item| convert_keys_to_symbols(item) }
+        else
+          obj
+        end
+      end
+    end
+  end
+end

data/lib/wa_cloud_api/message/service.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative 'client'
+require_relative 'error'
+
+module WaCloudApi
+  module Message
+    class Service
+      class << self
+        def deliver(params:)
+          response = Client.deliver(params: params)
+          handle_failure(response) unless response.ok?
+          response
+        end
+
+        private
+
+        def handle_failure(response)
+          WaCloudApi::Message::Error.new(response.data[:error]).handle_error
+        end
+      end
+    end
+  end
+end

data/lib/wa_cloud_api/message/text.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'service'
+require_relative 'base'
+
+module WaCloudApi
+  module Message
+    class Text < Base
+      attr_accessor :preview_url, :body
+
+      def initialize(to:, body:, preview_url: false)
+        @body = body
+        @preview_url = preview_url || false
+        super(to: to, type: 'text')
+      end
+
+      private
+
+      def request_params
+        {
+          messaging_product: messaging_product,
+          recipient_type: recipient_type,
+          to: to,
+          type: type,
+          text: {
+            preview_url: preview_url,
+            body: body
+          }
+        }
+      end
+    end
+  end
+end

data/lib/wa_cloud_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WaCloudApi
-  VERSION = "0.1.0"
+  VERSION = '0.1.1'
 end

data/lib/wa_cloud_api.rb

@@ -1,8 +1,20 @@
 # frozen_string_literal: true
 
-require_relative "wa_cloud_api/version"
+require_relative 'wa_cloud_api/version'
+require_relative 'wa_cloud_api/message/text'
+require_relative 'wa_cloud_api/message/reaction'
+require_relative 'wa_cloud_api/message/location'
+require_relative 'wa_cloud_api/configuration'
 
 module WaCloudApi
   class Error < StandardError; end
-  # Your code goes here...
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
 end

data/wa_cloud_api.gemspec

@@ -1,23 +1,23 @@
 # frozen_string_literal: true
 
-require_relative "lib/wa_cloud_api/version"
+require_relative 'lib/wa_cloud_api/version'
 
 Gem::Specification.new do |spec|
-  spec.name = "wa_cloud_api"
+  spec.name = 'wa_cloud_api'
   spec.version = WaCloudApi::VERSION
-  spec.authors = ["rvs-teja"]
-  spec.email = ["rvs.teja@jiva.ag"]
+  spec.authors = ['teja-rvs']
+  spec.email = ['tejaprogramer@gmail.com']
 
-  spec.summary = "Ruby SDK for Whatsapp Cloud API"
-  spec.description = "API for Whatsapp Cloud API"
-  spec.homepage = "https://github.com/rvs-teja/wa_cloud_api"
-  spec.required_ruby_version = ">= 2.6.0"
+  spec.summary = 'Ruby SDK for whatsapp cloud api'
+  spec.description = 'Ruby SDK for whatsapp cloud api'
+  spec.homepage = 'https://github.com/rvs-teja/wa_cloud_api'
+  spec.required_ruby_version = '>= 2.6.0'
 
   # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/rvs-teja/wa_cloud_api"
-  spec.metadata["changelog_uri"] = "https://github.com/rvs-teja/wa_cloud_api/CHANGELOG.md"
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/rvs-teja/wa_cloud_api'
+  spec.metadata['changelog_uri'] = 'https://github.com/rvs-teja/wa_cloud_api/blob/main/CHANGELOG.md'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -27,12 +27,13 @@ Gem::Specification.new do |spec|
         f.start_with?(*%w[bin/ test/ spec/ features/ .git appveyor Gemfile])
     end
   end
-  spec.bindir = "exe"
+  spec.bindir = 'exe'
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
   # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency 'faraday', '~> 2.9'
+  spec.add_dependency 'rubocop', '~> 1.60', '>= 1.60.1'
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html

metadata

@@ -1,27 +1,72 @@
 --- !ruby/object:Gem::Specification
 name: wa_cloud_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
-- rvs-teja
+- teja-rvs
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-10 00:00:00.000000000 Z
-dependencies: []
-description: API for Whatsapp Cloud API
+date: 2024-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.60.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.60.1
+description: Ruby SDK for whatsapp cloud api
 email:
-- rvs.teja@jiva.ag
+- tejaprogramer@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- LICENSE
 - README.md
 - Rakefile
 - lib/wa_cloud_api.rb
+- lib/wa_cloud_api/client.rb
+- lib/wa_cloud_api/configuration.rb
+- lib/wa_cloud_api/message/base.rb
+- lib/wa_cloud_api/message/client.rb
+- lib/wa_cloud_api/message/error.rb
+- lib/wa_cloud_api/message/location.rb
+- lib/wa_cloud_api/message/reaction.rb
+- lib/wa_cloud_api/message/response.rb
+- lib/wa_cloud_api/message/service.rb
+- lib/wa_cloud_api/message/text.rb
 - lib/wa_cloud_api/version.rb
 - sig/wa_cloud_api.rbs
 - wa_cloud_api.gemspec
@@ -30,7 +75,7 @@ licenses: []
 metadata:
   homepage_uri: https://github.com/rvs-teja/wa_cloud_api
   source_code_uri: https://github.com/rvs-teja/wa_cloud_api
-  changelog_uri: https://github.com/rvs-teja/wa_cloud_api/CHANGELOG.md
+  changelog_uri: https://github.com/rvs-teja/wa_cloud_api/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -49,5 +94,5 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: Ruby SDK for Whatsapp Cloud API
+summary: Ruby SDK for whatsapp cloud api
 test_files: []