africastalking 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3d0b35aae16aebd67ba39e0c271a9aba00d353e4
+  data.tar.gz: a3d6e06b041387de0854fe301e9a44aaf27c6281
+SHA512:
+  metadata.gz: 5ee0170e5a13b14dfed9ecdbc4208bb055630e95573b80ae4fee4483918838cce6effd3615fd3572bb8659d057f1de99ab35309b3f5391f72a831604805d5046
+  data.tar.gz: 43f8abb01d6d0173b66e8b8b235dd697c9982ac6b1e66b41a885bcf430aafd1ee8c9917119278e2450e86955f40cbf95fbf21d96b93a94e627be5c3435ee3e80

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/lib/africastalking/sample.rb
+/lib/africastalking/AfricasTalkingGateway.rb

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,9 @@
+sudo: false
+language: ruby
+language: ruby
+rvm:
+  - 2.2.2
+  - 2.1.1
+  - 2.1.0
+  - 2.0.0
+before_install: gem install bundler -v 1.12.5

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 chalcchuck@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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in africastalking.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Charles Chuck
+
+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,47 @@
+# Africastalking
+[![Code Climate](https://codeclimate.com/github/chalchuck/africastalking/badges/gpa.svg)](https://codeclimate.com/github/chalchuck/africastalking)
+
+[![Issue Count](https://codeclimate.com/github/chalchuck/africastalking/badges/issue_count.svg)](https://codeclimate.com/github/chalchuck/africastalking)
+
+[![Build Status](https://travis-ci.org/chalchuck/africastalking.svg?branch=master)](https://travis-ci.org/chalchuck/africastalking)
+
+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/africastalking`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'africastalking'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install africastalking
+
+## 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 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/[USERNAME]/africastalking. 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/africastalking.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'africastalking/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "africastalking"
+  spec.version       = Africastalking::VERSION
+  spec.authors       = ["Charles Chuck"]
+  spec.email         = ["chalcchuck@gmail.com"]
+
+  spec.summary       = %q{Africas Best SMS/AIRTIME API}
+  spec.description   = %q{Africas SMS/AIRTIME API}
+  spec.homepage      = "https://africastalking.com/"
+  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_dependency 'httparty', "~> 0.13.7"
+
+  spec.add_development_dependency "pry", "~>0.10.4"
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "africastalking"
+
+# 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 @@
+#!/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/africastalking.rb

@@ -0,0 +1,25 @@
+require "africastalking/configuration"
+require "africastalking/connection"
+require "africastalking/message"
+require "africastalking/response"
+require "africastalking/airtime"
+require "africastalking/version"
+require "africastalking/user_data"
+require "africastalking/subscription"
+require "africastalking/talk"
+
+module Africastalking
+
+  class << self
+    attr_writer :configuration
+
+    def setup
+      yield configuration
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+    alias_method :config, :configuration
+  end
+end

data/lib/africastalking/airtime.rb

@@ -0,0 +1,27 @@
+module Africastalking
+  class Airtime < Connection
+    class << self
+
+      def send(recipients)
+        post('/version1/airtime/send', build_airtime(recipients))
+      end
+      alias_method :buy, :send
+
+    private
+
+      def build_airtime(recipients)
+        {"username" => Africastalking.config.username, "recipients" => build_recipients(recipients).to_json}
+      end
+
+      def build_recipient(recipient)
+				{"phoneNumber" => "#{recipient.fetch(:mobile_number)}", "amount" => "KES #{recipient.fetch(:airtime, 0.0)}"}
+      end
+
+			def build_recipients(recipients)
+				airtime_recipients = Array.new
+				recipients.each {|recipient| airtime_recipients << build_recipient(recipient)}
+				airtime_recipients
+			end
+    end
+  end
+end

data/lib/africastalking/configuration.rb

@@ -0,0 +1,18 @@
+module Africastalking
+	class Configuration
+		attr_accessor :username, :apikey
+
+		def initialize(params={})
+			@user ||= params.dig(:username)
+			@pass ||= params.dig(:apikey)
+		end
+
+		def header
+		  {
+				"apikey" => apikey,
+				'Accept' => 'application/json',
+				'Content-Type'=> 'application/x-www-form-urlencoded'
+			}
+		end
+	end
+end

data/lib/africastalking/connection.rb

@@ -0,0 +1,30 @@
+require 'httparty'
+
+module Africastalking
+	class Connection
+		include HTTParty
+
+		headers
+		format :json
+		base_uri "https://api.africastalking.com"
+
+		class << self
+
+			def headers
+				Africastalking.configuration.header.merge!(super)
+			end
+
+			%w(get put post delete).each do |method|
+				define_method method do |path, options={}, &block|
+					json_body = {body: options}
+					response  = perform_request Net::HTTP::Put,    path, json_body, &block if method.eql?('put')
+					response  = perform_request Net::HTTP::Post,   path, json_body, &block if method.eql?('post')
+					response  = perform_request Net::HTTP::Get,    path, json_body, &block if method.eql?('get')
+					response  = perform_request Net::HTTP::Delete, path, json_body, &block if method.eql?('delete')
+
+					Africastalking::Response.new(code: response.code, headers: response.headers, body: response.body)
+				end
+			end
+		end
+	end
+end

data/lib/africastalking/message.rb

@@ -0,0 +1,59 @@
+module Africastalking
+  class Message < Connection
+    class << self
+
+      def fetch(last_received_id=0)
+        get("/version1/messaging?username=#{Africastalking.config.username}&lastReceivedId=#{last_received_id}")
+      end
+
+      def send(recipients, message)
+        post('/version1/messaging', build_message(recipients, message))
+      end
+
+      def send_premium(data)
+        post('/version1/messaging', build_premium_messages(data))
+      end
+
+      def enqueue_message(data)
+        post('/version1/messaging', build_enqueued_messages(data))
+      end
+
+    private
+
+      def build_message(recipients, message)
+        {username: Africastalking.config.username, message: message, to: prepare_recipients(recipients)}
+      end
+
+      def premium_params(data)
+        {
+          retryDurationInHours: data.fetch(:retryDurationInHours, 1),
+          enqueue: data.fetch(:enqueue, 0), linkId: data.fetch(:linkId, nil), keyword: data.fetch(:keyword, nil)
+        }
+      end
+
+      def enqueue_params(data)
+        {
+          bulkSMSMode: data.fetch(:bulkSMSMode, 1), sender: data.fetch(:sender, nil), enqueue: data.fetch(:enqueue, 1)
+        }
+      end
+
+      def prepare_recipients(recipients)
+        msg_recipients = Array.new
+        recipients.split(',').each {|r| msg_recipients << r.strip}
+        msg_recipients.join(', ')
+      end
+
+      def build_enqueued_messages(data)
+        build_message(
+          prepare_recipients(data.fetch(:recipients, [])), data.fetch(:message, '')
+        ).merge(enqueue_params(data))
+      end
+
+      def build_premium_messages(data)
+        build_message(
+          prepare_recipients(data.fetch(:recipients, [])), data.fetch(:message, '')
+        ).merge(premium_params(data))
+      end
+    end
+  end
+end

data/lib/africastalking/response.rb

@@ -0,0 +1,13 @@
+require 'json'
+
+module Africastalking
+  class Response
+    attr_reader :code, :headers, :body
+
+    def initialize(params)
+      @headers = params.dig(:headers)
+      @code    = params.dig(:code)
+      @body    = JSON.parse(params.dig(:body))
+    end
+  end
+end

data/lib/africastalking/subscription.rb

@@ -0,0 +1,48 @@
+module Africastalking
+  class Subscription < Connection
+    class << self
+
+      def create(data)
+        validate_attributes(%w(phone_number short_code keyword), data)
+				post("/version1/subscription/create", build_subscription(data))
+      end
+
+      def delete(data)
+				validate_attributes(%w(phone_number short_code keyword), data)
+				post("/version1/subscription/delete", build_subscription(data))
+      end
+
+      def fetch(data)
+				validate_attributes(%w(short_code keyword), data)
+
+        fetch_url = %{
+          /version1/subscription?
+          username=#{Africastalking.config.username}&
+          shortCode=#{data.fetch(:short_code)}&keyword=#{data.fetch(:keyword)}&
+          lastReceivedId=#{data.fetch(:last_received_id, 0)}
+        }
+
+				get(fetch_url)
+      end
+
+    private
+
+      def validate_attributes(attrbs, data)
+        attrbs.each do |value|
+          fail "#{value} can not be blank!" if value_present?(data, value)
+        end
+      end
+
+      def value_present?(data, value)
+        data[value.to_sym].empty?
+      end
+
+      def build_subscription(data)
+        {
+          username: Africastalking.config.username, keyword: data.fetch(:keyword),
+          phoneNumber: data.fetch(:phone_number), shortCode: data.fetch(:short_code)
+        }
+      end
+    end
+  end
+end

data/lib/africastalking/talk.rb

@@ -0,0 +1,21 @@
+module Africastalking
+  class Talk < Connection
+    base_uri 'https://voice.africastalking.com'
+
+    class << self
+
+      def make_call(from, to)
+        post('/call', {"username" => Africastalking.config.username, 'from' => from, 'to' => to})
+      end
+
+      def fetch_queued_calls(phone_number, queue_name=nil)
+        post('/queueStatus', {"username" => Africastalking.config.username, "phoneNumbers" => phone_number, "queueName" => queue_name})
+      end
+
+      def upload_file(url)
+        post('/mediaUpload', {"username" => Africastalking.config.username, 'url' => url})
+      end
+
+    end
+  end
+end

data/lib/africastalking/user_data.rb

@@ -0,0 +1,10 @@
+module Africastalking
+  class UserData < Connection
+    class << self
+
+      def retrieve
+        get("/version1/user?username=#{Africastalking.config.username}")
+      end
+    end
+  end
+end

data/lib/africastalking/version.rb

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

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: africastalking
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Charles Chuck
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Africas SMS/AIRTIME API
+email:
+- chalcchuck@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- africastalking.gemspec
+- bin/console
+- bin/setup
+- lib/africastalking.rb
+- lib/africastalking/airtime.rb
+- lib/africastalking/configuration.rb
+- lib/africastalking/connection.rb
+- lib/africastalking/message.rb
+- lib/africastalking/response.rb
+- lib/africastalking/subscription.rb
+- lib/africastalking/talk.rb
+- lib/africastalking/user_data.rb
+- lib/africastalking/version.rb
+homepage: https://africastalking.com/
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Africas Best SMS/AIRTIME API
+test_files: []