africa_talking 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1a6924b84cf7106322983e6e2c885ec65d65e149c64c78690a977b314c06671a
+  data.tar.gz: cafa7f563bf352da68f8dbb790a655d0758bbec840933009999c4610a014cabf
+SHA512:
+  metadata.gz: bcbdbc2406390d52ce2df66b28ff6817440613fbf0d9c5e50fdbb92bcae73449f35d14fdc2f6a3023ba12a0a5c68564680b7b8e5e4f80e918b1ba692d5e5818a
+  data.tar.gz: 497e24217d12cd97f329f3515b3daa6148881d8c1bc568928a630477bc6ae033c94da4ee9486be4fe9d52317ad7d331eb2b1ef7ab48de3edc6259dacf78533bb

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at onwuemenefavour@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in africa_talking.gemspec
+gemspec
+
+gem 'virtus', '1.0.5'
+gem 'rest-client', '>= 1.6.7'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Favourite Onwuemene
+
+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

@@ -0,0 +1,40 @@
+# AfricaTalking
+
+Ruby Gem for [Africa Talking](https://build.at-labs.io/docs/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'africa_talking'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install africa_talking
+
+## Usage
+
+TODO
+
+
+## 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 tags, 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/favour121/africa_talking. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/africa_talking.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'africa_talking/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "africa_talking"
+  spec.version       = AfricaTalking::VERSION
+  spec.authors       = ["Favourite Onwuemene"]
+  spec.email         = ["onwuemenefavour@gmail.com"]
+
+  spec.summary       = %q{Infobip (infobip.com) Ruby API.}
+  spec.description   = %q{Infobip (infobip.com) Ruby API.}
+  spec.homepage      = "https://github.com/favour121/africa_talking"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency "virtus"
+  spec.add_dependency "rest-client"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "africa_talking"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+e#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/africa_talking.rb

@@ -0,0 +1,9 @@
+require "virtus"
+require "africa_talking/version"
+require "africa_talking/client"
+require "africa_talking/models"
+require "africa_talking/requests"
+
+module AfricaTalking
+  # Your code goes here...
+end

data/lib/africa_talking/client.rb

@@ -0,0 +1,60 @@
+require 'base64'
+require 'json'
+require 'rest-client'
+
+module AfricaTalking
+
+  class Client
+    API_BASE_URL_SANDBOX = 'https://api.sandbox.africastalking.com/version1/'
+    API_BASE_URL = 'https://api.africastalking.com/version1/'
+
+    def initialize(username, apiKey, sandbox_mode = false)
+      @username = username
+      @apiKey = apiKey
+      @sandbox_mode = sandbox_mode
+    end
+
+    def username
+      @sandbox_mode ? 'sandbox' : @username
+    end
+
+    def send_request(sms_request)
+      if @sandbox_mode
+        url = API_BASE_URL_SANDBOX + sms_request.route
+      else
+        url = API_BASE_URL + sms_request.route
+      end
+      method = sms_request.http_method
+      payload = {}
+      headers = client_headers.merge(sms_request.headers)
+
+      headers = headers.merge(params: client_payload) if sms_request.http_method == :get
+      payload = client_payload.merge(sms_request.payload) if method != :get
+
+      begin
+        response = RestClient::Request.execute(method: method, url: url, payload: payload, headers: headers)
+      rescue RestClient::ExceptionWithResponse => err
+        raise err
+      end
+
+      response_hash = JSON.parse(response.body)
+      sms_request.response_class.new(response_hash)
+    end
+
+    def client_payload
+      {'username': self.username}
+    end
+
+    def client_headers
+      hsh = {
+          'User-Agent': "favour121/AfricaTalking-#{AfricaTalking::VERSION}",
+          'Content-Type': 'application/x-www-form-urlencoded',
+          'accept': 'application/json',
+          'apiKey': @apiKey
+      }
+      hsh
+    end
+
+  end
+
+end

data/lib/africa_talking/models.rb

@@ -0,0 +1,39 @@
+require 'json'
+
+module AfricaTalking
+
+  class Model
+    include ::Virtus.model(nullify_blank: true)
+
+    def body_attributes
+      attributes
+    end
+  end
+
+  class SMSResponseRecipientDetail < Model
+    attribute :statusCode, Integer
+    attribute :number, String
+    attribute :status, String
+    attribute :cost, String
+    attribute :messageId, String
+  end
+
+  class SMSResponseDetail < Model
+    attribute :Message, String
+    attribute :Recipients, Array[SMSResponseRecipientDetail]
+  end
+
+  class SendSMSResponse < Model
+    attribute :SMSMessageData, SMSResponseDetail
+  end
+
+  class SMSDeliveryCallbackNotification < Model
+    attribute :id, String
+    attribute :status, String
+    attribute :phoneNumber, String
+    attribute :networkCode, String
+    attribute :failureReason, String
+    attribute :retryCount, Integer
+  end
+
+end

data/lib/africa_talking/requests.rb

@@ -0,0 +1,2 @@
+require "africa_talking/requests/base_request_model"
+require "africa_talking/requests/send_sms_request"

data/lib/africa_talking/requests/base_request_model.rb

@@ -0,0 +1,22 @@
+require 'json'
+
+module AfricaTalking
+  class BaseRequestModel < Model
+
+    def payload
+      if http_method == :get
+        nil
+      else
+        body_attributes
+      end
+    end
+
+    def headers
+      if http_method == :get
+        {params: payload}
+      else
+        {}
+      end
+    end
+  end
+end

data/lib/africa_talking/requests/send_sms_request.rb

@@ -0,0 +1,34 @@
+require 'json'
+
+module AfricaTalking
+  class SendSMSRequest < BaseRequestModel
+    attribute :to, Array[String]
+    attribute :from, String, default: 'AFRICASTKNG'
+    attribute :message, String
+    attribute :bulkSMSMode, Integer, default: 1
+    attribute :enqueue, Integer, default: 1
+    attribute :keyword, String
+    attribute :linkId, String
+    attribute :retryDurationInHours, Integer, default: 12
+
+
+    def body_attributes
+      h = super
+      h[:to] = to.join(', ')
+      h
+    end
+
+    def route
+      'messaging'
+    end
+
+    def http_method
+      :post
+    end
+
+    def response_class
+      SendSMSResponse
+    end
+
+  end
+end

data/lib/africa_talking/version.rb

@@ -0,0 +1,3 @@
+module AfricaTalking
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: africa_talking
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Favourite Onwuemene
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Infobip (infobip.com) Ruby API.
+email:
+- onwuemenefavour@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- africa_talking.gemspec
+- bin/console
+- bin/setup
+- lib/africa_talking.rb
+- lib/africa_talking/client.rb
+- lib/africa_talking/models.rb
+- lib/africa_talking/requests.rb
+- lib/africa_talking/requests/base_request_model.rb
+- lib/africa_talking/requests/send_sms_request.rb
+- lib/africa_talking/version.rb
+homepage: https://github.com/favour121/africa_talking
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Infobip (infobip.com) Ruby API.
+test_files: []