cequens 0.0.2 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be3486da8322d3687e414560bd33e1d93eae35328e067d835bd721c29fa2caeb
-  data.tar.gz: 4b3d2575a79f5ac88041d3e57446aabe3750b17a8c396a7765fb4e65f847a001
+  metadata.gz: f11166fbdbe9870dc4ca38824b06c4bf8f508b9949f8722fe92cad32d527b25e
+  data.tar.gz: c6b5eb0a9c544b27922643e42fa87d864614ea2d5d5cd0593f687080980e3d13
 SHA512:
-  metadata.gz: 6a628284aaeee98c0c5a6830468c09802744eff644f1d2a2c64838a4e49ffef4b3ba14c810a1da9f81a4d7c95f3bb80bbd9fbc513b1d4ee279bfb37e466ab6c9
-  data.tar.gz: 2fa1bc796410c2a85d51d3a2378810d9b97f14c4f67489d83c11be552596aec462df6a2b040617e51fbdae19ec123c413cc5ce837105ff1b812e03f3e344006c
+  metadata.gz: 8588a8033b78e4bbe046297c18bf56c0d399b0603e918ea3d9ff21b0ee4669fbb73d4b5cfca862ceda6c6c2f11f39f512a0126c48b377efe629aecc93fb699e8
+  data.tar.gz: 6feb98cdd452e20c471bd8cbec09161defe58bdc2d66238a9847064af5b9f5aa61645a3daca27bba61c71ad255cffc34437fb7d40e5565cf00475b3dbc19dac9

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cequens (0.0.1)
+    cequens (0.0.6)
       dry-validation (~> 1.6)
       faraday (~> 0.17)
 

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 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
 
@@ -22,6 +22,15 @@ Or install it yourself as:
 
 ## Usage
 
+configure access token as:
+
+    $ 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
+    end
+
 ### Send SMS
 
 ```ruby
@@ -38,3 +47,12 @@ 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)/}) }

data/lib/cequens.rb

@@ -7,8 +7,10 @@ require 'cequens/request'
 require 'cequens/response'
 require 'cequens/requests/send_sms_request'
 require 'cequens/contracts/send_sms_contract'
-require 'byebug'
+require 'cequens/requests/get_sms_details_request'
+require 'cequens/contracts/get_sms_details_contract'
 require 'rails'
+require 'byebug'
 
 module Cequens
   class << self
@@ -21,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/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])

data/lib/cequens/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Cequens
-  VERSION = '0.0.2'
+  VERSION = '0.0.7'
 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,5 @@
+# frozen_string_literal: true
+
+Cequens.config do |c|
+  # c.access_token = token
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cequens
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.7
 platform: ruby
 authors:
 - Ahmed Ali
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-16 00:00:00.000000000 Z
+date: 2021-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-validation
@@ -171,20 +171,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