orchard-api-client-anm 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7fe24561d8560f4e72128ed35d5d381fcfa0df5b4102374a1da846e8d68df7dc
-  data.tar.gz: 79c20d0ae92d8847d57c00db007e21cc9b6d6717abda6ee77d708deae2eb4695
+  metadata.gz: c6e66ee039d048dcaeb3323ca7ba1011735941f43dd94d87f58558437b909a6a
+  data.tar.gz: 6360df2749da90c401d2e48906c9037d795f75dd00d1c465e7f503f1e83ab3eb
 SHA512:
-  metadata.gz: 3abc6c7eaaa9d264666c5f908972b8430c769b7f6ed419fc4d654927fe50c2173e7c7179dce9812b31a156875ec1352a34901b96ebd3c0f7c24f03e60e0a0d8c
-  data.tar.gz: 2517968d7648e3b6adc0428f7a4b450719b448bd15140ddcd4b0168b8fce5364fe15b320a8f859170acad69737f97e0e7d2db134e3cd95e912d45a384b0993b6
+  metadata.gz: e2c5dbeb84b5f2e0653ec185a57b2c2df9e9f6bfdf9733db8e70b18a9c743c1bbe1a8dfee3ace4bfe0d73bc703e37aecd532c3106a37bdbbf3bc7345aa7f0aac
+  data.tar.gz: 372f1b1aa0399f425630c1a65579624d191de5a56d7b54f7afd6701cdd006838cec4a34d7a4deb395d1fce814ddbc47185c94d6f92b16e2a846ddae24f9a5b16

data/.byebug_history

@@ -1,4 +1,44 @@
 exit
+"2343333333333333"[-9..]
+"2343333333333333".[-9..]
+r
+exit
+client.send_sms(sms_payload, {timeout: 5})
+client.send_sms(sms_payload, {timeout: 10})
+r
+exit
+r
+exit
+r
+exit
+client
+exit
+@connection
+r
+exit
+eit
+@endpoint
+r
+exit
+r
+exit
+r
+exit
+r
+exit
+r
+exit
+continue
+@timeout
+exit
+@timeout
+exit
+r
+exit
+r
+exit
+r
+exit
 r.body
 r.success?
 r.success

data/.rubocop.yml

@@ -1,6 +1,7 @@
 AllCops:
   TargetRubyVersion: 2.6
   SuggestExtensions: false
+  NewCops: disable
 
 Style/StringLiterals:
   Enabled: true
@@ -14,4 +15,7 @@ Layout/LineLength:
   Max: 120
 
 Style/Documentation:
-  Enabled: false
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 15

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    orchard_anm (0.1.0)
+    orchard-api-client-anm (0.1.1)
       byebug
       faraday (~> 2.6)
       rspec (~> 3.0)
@@ -58,7 +58,7 @@ PLATFORMS
 
 DEPENDENCIES
   faraday (~> 2.6)
-  orchard_anm!
+  orchard-api-client-anm!
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.21)

data/README.md

@@ -1,37 +1,68 @@
-# Orchard
-
-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/orchard`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+# Orchard API Client
+This api client integrates into appsNmobiles orchard payment solution
 
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add orchard
+    $ bundle add orchard-api-client-anm
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install orchard
+    $ gem install orchard-api-client-anm
 
 ## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/orchard. 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]/orchard/blob/master/CODE_OF_CONDUCT.md).
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the Orchard project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/orchard/blob/master/CODE_OF_CONDUCT.md).
+```ruby
+#load the gem class
+  require 'orchard'
+    
+#Create a client object with the secret token, client token, and the url
+  params = {
+    secret_token: ENV['SECRET_TOKEN'],
+    client_token: ENV['CLIENT_TOKEN'],
+    url: ENV['ORCHARD_URL']
+  }
+  
+  client = Orchard::ApiClient.new(params)
+ 
+#Use client object for various api functions
+
+#optional configuration configurations
+  request_configurations = {
+    timeout: 30
+  }
+
+#Send payment request
+    
+  randval_one = rand(999).to_s.center(3, rand(9).to_s)
+  strtm = Time.new.strftime("%d%H%M%L")
+  processing_id = strtm + randval_one
+  trans_type = allowed_parameters['CTM(client to merchant)' / 'MTC(merchant to client)']
+  nw = allowed_parameters['MTN','VOD','AIR']
+  
+  payment_request_payload = {
+    customer_number: '',
+    reference: '',
+    amount: '',
+    exttrid: processing_id,
+    nw: 'MTN',
+    trans_type: 'CTM',
+    callback_url: '/',
+    ts: Time.now.strftime("%Y-%m-%d %H:%M:%S"),
+    client_id: ENV['SERVICE_ID'],
+    voucher_code: ''
+  }
+ 
+  response = client.send_payment_request(payment_request_payload, _request_configurations)
+
+#Send Sms
+  sms_payload = {
+    sender_id: '',
+    recipient_number: '',
+    msg_body: '',
+    trans_type: 'SMS',
+    service_id: ENV['SERVICE_ID']
+  }
+
+  response = client.send_sms(sms_payload, _request_configurations)
+```

data/lib/orchard/api/base.rb

@@ -3,21 +3,38 @@
 module Orchard
   module API
     class Base
-      def initialize(params)
+      def initialize(params, request_configurations)
         @payload = params[:payload]
         @client_token = params[:client_token]
         @secret_token = params[:secret_token]
         @connection = params[:connection]
+        @timeout = request_configurations[:timeout] || 30
       end
 
-      def self.call(params)
-        new(params).call
+      def self.call(params, request_configurations)
+        new(params, request_configurations).call
       end
 
       def compute_signature
         digest = OpenSSL::Digest.new("sha256")
         OpenSSL::HMAC.hexdigest(digest, @secret_token.to_s, @payload.to_json)
       end
+
+      def make_post_request
+        response = @connection.post do |request|
+          request.url @endpoint
+          request.options.timeout = @timeout
+          request.body = @payload.to_json
+          request["Authorization"] = "#{@client_token}:#{compute_signature}"
+        end
+
+        JSON.parse(response.body)
+      rescue StandardError => e
+        {
+          "res_code" => "999",
+          "res_desc" => e.message
+        }
+      end
     end
   end
 end

data/lib/orchard/api/send_payment_request.rb

@@ -4,12 +4,8 @@ module Orchard
   module API
     class SendPaymentRequest < Orchard::API::Base
       def call
-        @connection.post do |request|
-          request.url Orchard::API::Constants::SEND_PAYMENT_REQUEST_ENDPOINT
-          request.options.timeout = 60
-          request.body = @payload.to_json
-          request["Authorization"] = "#{@client_token}:#{compute_signature}"
-        end
+        @endpoint = Orchard::API::Constants::SEND_PAYMENT_REQUEST_ENDPOINT
+        make_post_request
       end
     end
   end

data/lib/orchard/api/send_sms.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Orchard
+  module API
+    class SendSMS < Orchard::API::Base
+      def call
+        format_recipients_number
+        generate_unique_id
+        @endpoint = Orchard::API::Constants::SEND_SMS_ENDPOINT
+        make_post_request
+      end
+
+      def format_recipients_number
+        recipient_number = @payload[:recipient_number]
+        return unless recipient_number
+
+        @payload[:recipient_number] = "233#{recipient_number[-9..]}"
+      end
+
+      def generate_unique_id
+        @payload[:unique_id] = Time.now.strftime("%y%m%d%L%H%M")
+      end
+    end
+  end
+end

data/lib/orchard/api_client.rb

@@ -9,8 +9,12 @@ module Orchard
       @connection = create_connection
     end
 
-    def send_payment_request(payload)
-      Orchard::API::SendPaymentRequest.call(token_and_payload(payload))
+    def send_payment_request(payload, request_configurations = {})
+      Orchard::API::SendPaymentRequest.call(token_and_payload(payload), request_configurations)
+    end
+
+    def send_sms(payload, request_configurations = {})
+      Orchard::API::SendSMS.call(token_and_payload(payload), request_configurations)
     end
 
     private

data/lib/orchard/constants.rb

@@ -4,6 +4,7 @@ module Orchard
   module API
     module Constants
       SEND_PAYMENT_REQUEST_ENDPOINT = "/sendRequest"
+      SEND_SMS_ENDPOINT = "/sendSms"
     end
   end
 end

data/lib/orchard/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Orchard
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

data/lib/orchard.rb

@@ -6,5 +6,6 @@ require_relative "orchard/version"
 require_relative "orchard/constants"
 require_relative "orchard/api/base"
 require_relative "orchard/api/send_payment_request"
+require_relative "orchard/api/send_sms"
 
 require_relative "orchard/api_client"

data/orchard.gemspec

@@ -31,9 +31,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Uncomment to register a new dependency of your gem
-  spec.add_dependency "byebug"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_dependency "faraday", "~> 2.6"
-  spec.add_dependency "rspec", "~> 3.0"
+  
+  
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: orchard-api-client-anm
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Sydney Dapilah
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-19 00:00:00.000000000 Z
+date: 2022-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -17,7 +17,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -25,33 +25,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
-  type: :runtime
+        version: '3.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.6'
 description: Orchard API client
 email:
 - sydney@appsnmobilesolutions.com
@@ -72,6 +72,7 @@ files:
 - lib/orchard.rb
 - lib/orchard/api/base.rb
 - lib/orchard/api/send_payment_request.rb
+- lib/orchard/api/send_sms.rb
 - lib/orchard/api_client.rb
 - lib/orchard/constants.rb
 - lib/orchard/version.rb