cequens 0.0.3 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0bcc7361c6c86cc6656eb61e4c79e70b6cfd1069de5e84e3d7b72c83f4f083fa
-  data.tar.gz: 214138dc5132d0824c7187125eac67637d89ff6b093c2a43bb0aacd032d8057e
+  metadata.gz: d48f378b1cdf8112f66fcbf5334fd24efaafd1ca2699aa077c65cfac7f23ec82
+  data.tar.gz: a4220da33061ff0203372fc1a04cfcee0d39bd9085f2c63dc21b73e64f83c183
 SHA512:
-  metadata.gz: 87c5ee0377b7b180c52c471ff51cc7d40e21e84d4aed6036fe63aa61ce977ad9325394290743fd21445e47bff1796d302ce3af78dc7d463bb910e841e9dac041
-  data.tar.gz: 752b10ae30c0e3320ec1af2fcb50a6910c25665d010aaf2da2dcf4d654cf983186ee2f2536448ff1db12a460a26921b4eb9b82ab4100a2d5b836d31a58f1fe84
+  metadata.gz: 7786df951d1aaca3e9d01409d7006586afed83f94d0c1d4203c6c5fd9a296f54d69ffcd39761ff41b05094793bec08938c3a78681482ec7a9fee15972a09a37f
+  data.tar.gz: d6882edcdbd90d7fc995d09ac7b69ad367d5e00d2bb03e3dec1c18aa066c54de80489ce16c9f4073faec63986983e972efa3b0a611c09c558558ebfe7d171e7c

data/.github/workflows/ruby.yml

@@ -19,4 +19,9 @@ jobs:
       run: rubocop
     - name: Run tests
       run: bundle exec rake spec
+    - name: Brakeman action
+      uses: artplan1/brakeman-action@v1.2.1
+      with:
+        flags: "--force"
+
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cequens (0.0.1)
+    cequens (0.0.7)
       dry-validation (~> 1.6)
       faraday (~> 0.17)
 
@@ -70,6 +70,7 @@ GEM
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
+    brakeman (5.0.0)
     builder (3.2.4)
     byebug (11.1.3)
     concurrent-ruby (1.1.8)
@@ -225,6 +226,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  brakeman (~> 5.0)
   bundler (~> 2.0)
   byebug (~> 11.1)
   cequens!

data/README.md

@@ -1,8 +1,8 @@
 # Cequens
 
-**Disclaimer:** we are not officially affilated with the Cequens company.
+**Disclaimer:** we are not officially affilated with [Cequens](https://developer.cequens.com) company.
 
-A plug-and-play library that make it easier to use with Cequens SMS APIs
+A plug-and-play library that make it easier to use Cequens SMS APIs
 
 ## Installation
 
@@ -24,7 +24,13 @@ Or install it yourself as:
 
 configure access token as:
 
-$ rails g cequens config
+    $ rails g cequens:config
+
+    Cequens.config do |c|
+    # c.access_token = token # add your access token not api token
+    # access_token is what you get when you login
+    # c.sender_name = sender_name
+    end
 
 ### Send SMS
 
@@ -41,3 +47,13 @@ res = Cequens.send_sms(params)
 
 res.success? # => true
 ```
+
+### Get SMS Details
+
+```ruby
+res = Cequens.get_sms_details(id: "AAAAA")
+#  => #<Cequens::Response:0x00007ffd672b29f8 @api_response={"replyCode"=>0, "replyMessage"=>"Request handled successfully", "requestId"=>"64035880-7044-11eb-9f04-11a5522e89a7", "clientRequestId"=>0, "requestTime"=>"2021-02-16T10:47:40.296", "data"=>{"SentSMSIDs"=>[{"SMSId"=>"056ef72a-1497-47be-a4c8-4a7835e071dc"}], "InvalidRecipients"=>""}}>
+
+res.success? # => true
+res.message # => Request handled successfully
+```

data/cequens.gemspec

@@ -13,8 +13,8 @@ Gem::Specification.new do |spec|
   spec.summary       = 'A library to interface with Cequens SMS gateway API.'
   spec.license       = 'MIT'
 
-  spec.metadata['homepage_uri'] = 'https://github.com/AhmedAIbrahim/cequens'
-  spec.metadata['source_code_uri'] = 'https://github.com/AhmedAIbrahim/cequens'
+  spec.metadata['homepage_uri'] = 'https://github.com/AhmedAliIbrahim/cequens'
+  spec.metadata['source_code_uri'] = 'https://github.com/AhmedAliIbrahim/cequens'
 
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'dry-validation', '~> 1.6'
   spec.add_dependency 'faraday', '~> 0.17'
 
+  spec.add_development_dependency 'brakeman', '~> 5.0'
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'byebug', '~> 11.1'
   spec.add_development_dependency 'rails', '~> 6.1'

data/lib/cequens.rb

@@ -7,11 +7,14 @@ require 'cequens/request'
 require 'cequens/response'
 require 'cequens/requests/send_sms_request'
 require 'cequens/contracts/send_sms_contract'
+require 'cequens/requests/get_sms_details_request'
+require 'cequens/contracts/get_sms_details_contract'
 require 'rails'
+require 'byebug'
 
 module Cequens
   class << self
-    attr_accessor :access_token
+    attr_accessor :access_token, :sender_name
 
     def config
       yield self
@@ -20,5 +23,9 @@ module Cequens
     def send_sms(params, opts = {})
       Request.new('send_sms', params, opts).fire_request
     end
+
+    def get_sms_details(params, opts = {})
+      Request.new('get_sms_details', params, opts).fire_request
+    end
   end
 end

data/lib/cequens/connection.rb

@@ -8,10 +8,12 @@ module Cequens
     CEQUENS_BASE_URL = 'https://apis.cequens.com/'
 
     class << self
-      def post(path, params, body, _options)
-        conn = connection
+      def get(path, _params, _body, _options)
+        connection.get(path)
+      end
 
-        conn.post(path) do |request|
+      def post(path, params, body, _options)
+        connection.post(path) do |request|
           request.params = params
           request.body = body.to_json
         end

data/lib/cequens/contracts/get_sms_details_contract.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'dry-validation'
+
+module Cequens
+  module Contracts
+    class GetSMSDetailsContract < Dry::Validation::Contract
+      params do
+        required(:id).value(:string)
+      end
+    end
+  end
+end

data/lib/cequens/contracts/send_sms_contract.rb

@@ -10,8 +10,8 @@ module Cequens
       params do
         required(:recipients).value(:string)
         required(:messageText).value(:string)
-        required(:senderName).value(:string)
         required(:messageType).value(included_in?: MESSAGE_TYPE)
+        optional(:senderName).value(:string)
         optional(:validityPeriod).value(:string)
         optional(:clientMessageId).value(:integer)
         optional(:acknowledgement).value(included_in?: KEYS)

data/lib/cequens/request.rb

@@ -22,6 +22,10 @@ module Cequens
         self.class.include Requests::SendSMSRequest
         validate_params!
         @request = build_send_sms_request
+      when 'get_sms_details'
+        self.class.include Requests::GetSMSDetailsRequest
+        validate_params!
+        @request = build_get_sms_details_request
       end
     end
   end

data/lib/cequens/requests/get_sms_details_request.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Cequens
+  module Requests
+    module GetSMSDetailsRequest
+      DEFAULTS = {}.freeze
+
+      def fire_request
+        cequens_api_response = Connection.get(request[:path], request[:params], request[:body], request[:options])
+        response_body = JSON.parse(cequens_api_response.body)
+
+        Response.new(response_body)
+      end
+
+      private
+
+      def build_get_sms_details_request
+        {
+          path: "sms/v1/messages/#{message_id}",
+          params: {},
+          body: {},
+          options: options
+        }
+      end
+
+      def request_params
+        @request_params ||= DEFAULTS.merge(params)
+      end
+
+      def message_id
+        request_params[:id]
+      end
+
+      def validate_params!
+        contract = Contracts::GetSMSDetailsContract.new.call(request_params)
+        raise InvalidCequensRequestError, contract.errors.to_h if contract.failure?
+      end
+    end
+  end
+end

data/lib/cequens/requests/send_sms_request.rb

@@ -3,7 +3,7 @@
 module Cequens
   module Requests
     module SendSMSRequest
-      DEFAULTS = {}.freeze
+      DEFAULTS = { messageType: 'text' }.freeze
 
       def fire_request
         cequens_api_response = Connection.post(request[:path], request[:params], request[:body], request[:options])
@@ -32,7 +32,7 @@ module Cequens
       def request_transformed_params
         {
           messageText: request_params[:messageText],
-          senderName: request_params[:senderName],
+          senderName: sender_name,
           messageType: request_params[:messageType],
           recipients: request_params[:recipients],
           clientMessageId: request_params[:clientMessageId],
@@ -48,6 +48,15 @@ module Cequens
         }.compact
       end
 
+      def sender_name
+        if request_params[:sender_name].nil?
+          request_params[:sender_name] =
+            Cequens.sender_name
+        else
+          request_params[:sender_name]
+        end
+      end
+
       # rubocop:enable Metrics/AbcSize
       # rubocop:enable Metrics/MethodLength
 

data/lib/cequens/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Cequens
-  VERSION = '0.0.3'
+  VERSION = '0.0.8'
 end

data/lib/generators/cequens/config_generator.rb

@@ -14,7 +14,7 @@ module Cequens
       DESC
 
       def copy_config_file
-        template 'cequens_template.rb', 'config/initializers/cequens.rb'
+        template 'cequens_config.rb', 'config/initializers/cequens.rb'
       end
     end
   end

data/lib/generators/cequens/templates/cequens_config.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+Cequens.config do |c|
+  c.access_token = 'your_token'
+  # replace sender id with yours
+  c.sender_name = 'Cequens'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cequens
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.8
 platform: ruby
 authors:
 - Ahmed Ali
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-16 00:00:00.000000000 Z
+date: 2021-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-validation
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: brakeman
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -171,20 +185,22 @@ files:
 - cequens.gemspec
 - lib/cequens.rb
 - lib/cequens/connection.rb
+- lib/cequens/contracts/get_sms_details_contract.rb
 - lib/cequens/contracts/send_sms_contract.rb
 - lib/cequens/errors.rb
 - lib/cequens/request.rb
+- lib/cequens/requests/get_sms_details_request.rb
 - lib/cequens/requests/send_sms_request.rb
 - lib/cequens/response.rb
 - lib/cequens/version.rb
 - lib/generators/cequens/config_generator.rb
-- lib/generators/cequens/templates/cequens_template.rb
+- lib/generators/cequens/templates/cequens_config.rb
 homepage:
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/AhmedAIbrahim/cequens
-  source_code_uri: https://github.com/AhmedAIbrahim/cequens
+  homepage_uri: https://github.com/AhmedAliIbrahim/cequens
+  source_code_uri: https://github.com/AhmedAliIbrahim/cequens
 post_install_message:
 rdoc_options: []
 require_paths:

data/lib/generators/cequens/templates/cequens_template.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-Cequens.configure do |config|
-  # config.access_token = ''
-end