orange_sms 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 358e2176de12b80c6213c01ea53cab1870db84cee14affe6fff40c5aa9e80157
+  data.tar.gz: fe30e2f9f8d949752bfa8a7a7dd1e585c824ff8fb3854b458cf6d294177e8a81
+SHA512:
+  metadata.gz: 924a972fe3198e375a22d676cad0a1a373e0d5248db4c435709608e0d5f5798732277be0e1bad345c27570fed7ad78c2f8feecd592d3f886958084b9585f0a2f
+  data.tar.gz: 4813a5d5e92f9608057d02afe91c8df1a6a6bec2ef101d1364cc8f0a2b034a031f9c36d7ce29e6f854c213baf5b1dd33308b994fe21ccef3c925504a28afe916

data/.gitignore

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

data/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/.travis.yml

@@ -0,0 +1,18 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 2.1.4
+matrix:
+  fast_finish: true
+script:
+- sh script/travis.sh
+deploy:
+  provider: pages
+  skip-cleanup: true
+  github-token: $GITHUB_TOKEN
+  keep-history: true
+  verbose: true
+  on:
+    branch: master

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 TODO: Write your name
+
+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,117 @@
+# OrangeSms
+![Build Status](https://travis-ci.com/bayevels/orange-sms-ruby.svg?branch=master)
+[![Coverage](https://bayevels.github.io/orange-sms-ruby/badges/coverage_badge_total.svg)](https://bayevels.github.io/orange-sms-ruby/coverage/index.html)
+> Orange Sms Ruby is a client library that allow you to send sms from a RoR app using the [Orange Sms API](https://developer.orange.com/apis/sms-sn/overview)
+
+## Disclaimer
+This gem is not an official client of Orange, in order to use the client you need to create a [Orange Sms API](https://developer.orange.com/apis/sms-sn/overview) and to register an app in the developer dashboard that orange provide to you. After registering your app you can ask for sms integration approval (this process can take time :)).
+The registration process is detailed [here](https://developer.orange.com/apis/sms-sn/overview)
+## Motivation
+Instead of reading and trying to understand once again how the Orange Sms API work this gem aims to let you quickly send sms from a ruby  app (mainly RoR) using the [Orange Sms API](https://developer.orange.com/apis/sms-sn/overview).
+
+```ruby
+# default receiver country is Senegal (:sen)
+client = OrangeSms::Client.new
+client.send_sms('776879809', 'Simple comme bonjour !')
+# Or specify the country code when sending
+client = OrangeSms::Client.new(:civ) # Ivory coast code
+client.send_sms('776879809', 'Simple comme bonjour !')
+```
+## Getting Started
+
+### Setup
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'orange_sms'
+```
+Then run `bundle install`
+
+Next, you need to run the generator:
+
+```ruby
+rails generate orange_sms:install
+```
+The generator will create an initializer file `/config/initializers/orange_sms.rb`.
+You can setup, your app information there.
+```ruby
+OrangeSms.setup do |config|
+  # Sender Name
+  # config.sender_name = 'GITHUB'
+  config.sender_name = 'put your coporate name here'
+
+  # Sender Phone
+  config.sender_phone = 'put your phone number here'
+
+  # Sender country code. Follow ISO-3166 alpha 3 country codes. Default country value is :sen (Senegal)
+  # You can find supported countries by Orange Api in the folllowing link https://developer.orange.com/apis/sms-sn/getting-started
+  # config.sender_country_code = :sen
+
+  # Follow ISO-3166 alpha 3 country codes. Default country value is :sen (Senegal)
+  # Use the country code of your receivers. You can find supported countries by Orange Api in the folllowing link https://developer.orange.com/apis/sms-sn/getting-started
+  # config.default_receiver_country_code = :sen
+
+  # Authorization Header you can find the Authorization header in your app dashboard https://developer.orange.com/myapps
+  config.authorization = 'put your Authorization Header here !' 
+
+  # Generate the access token with the interactive console
+  # --> client = OrangeSms::Client.new
+  # --> client.fetch_access_token => 'CeppeLvEUgWK4o0r2WW2IzBrMQEn'
+  config.access_token = 'put your access_token here !'
+end
+```
+### Generate Access token
+in order to fetch the access token you need first to get the Authorization header from your Orange developer dashboard and to add it to your configuration file
+```ruby
+config.authorization = 'Basic NktSSHljksdj7P...Jjndb6UdnlrT2lOaA==' 
+```
+You can now get your access token using the rails console. Run in your terminal `rails console` and next
+```ruby
+client = OrangeSms::Client.new
+client.fetch_access_token ==> i6m2iIcY0SodWSe...L3ojAXXrH
+```
+Copy it and paste it into your initializer file, and add it to the initializer file `/config/initializers/orange_sms.rb`
+```ruby
+config.access_token = 'i6m2iIcY0SodWSe...L3ojAXXrH' # You may use ENV variables
+```
+:warning: The access token will last 7776000 seconds, i.e. 90 days. After this period, you'll get an error and should request another token.
+
+### Test it :sunglasses:
+you can test the integration in the rails console, open up the console `rails console` next run the code down below
+```ruby
+# default receiver country is Senegal (:sen)
+client = OrangeSms::Client.new
+client.send_test_sms # Will send sms to the sender_phone that you have specified inside `/config/initializers/orange_sms.rb`.
+```
+### Send Sms
+```ruby
+# default receiver country is Senegal (:sen)
+client = OrangeSms::Client.new
+client.send_sms('776879809', 'Simple comme bonjour !')
+# Or specify the country code when sending
+client = OrangeSms::Client.new(:civ) # Ivory coast code
+client.send_sms('776879809', 'Simple comme bonjour !')
+```
+### Handling Errors
+```ruby
+begin
+  client = OrangeSms::Client.new
+  client.send_sms('776879809', 'Simple comme bonjour !')
+rescue OrangeSms::Error::ApiError => e
+  puts e.message
+end
+```
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/bayevels/orange_sms.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "orange_sms"
+
+# 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(__FILE__)

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/generators/orange_sms/USAGE

@@ -0,0 +1,8 @@
+  
+Description:
+  Generates the necessary files to get you up and running with OrangeSms gem
+
+Examples:
+  rails generate orange_sms:install
+
+    This will generate the initializer file

data/lib/generators/orange_sms/install_generator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'rails/generators/base'
+
+module OrangeSms
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('./templates', __dir__)
+
+      def copy_initializer
+        copy_file 'orange_sms.rb', 'config/initializers/orange_sms.rb'
+      end
+    end
+  end
+end

data/lib/generators/orange_sms/templates/orange_sms.rb

@@ -0,0 +1,24 @@
+OrangeSms.setup do |config|
+  # Sender Name
+  # config.sender_name = 'GITHUB'
+  config.sender_name = 'put your coporate name here'
+
+  # Sender Phone
+  config.sender_phone = 'put your phone number here'
+
+  # Sender country code. Follow ISO-3166 alpha 3 country codes. Default country value is :sen (Senegal)
+  # You can find supported countries by Orange Api in the folllowing link https://developer.orange.com/apis/sms-sn/getting-started
+  # config.sender_country_code = :sen
+
+  # Follow ISO-3166 alpha 3 country codes. Default country value is :sen (Senegal)
+  # Use the country code of your receivers. You can find supported countries by Orange Api in the folllowing link https://developer.orange.com/apis/sms-sn/getting-started
+  # config.default_receiver_country_code = :sen
+
+  # Authorization Header you can find the Authorization header in your app dashboard https://developer.orange.com/myapps
+  config.authorization = 'put your Authorization Header here !'
+
+  # Generate the access token with the interactive console
+  # --> client = OrangeSms::Client.new
+  # --> client.fetch_access_token => 'CeppeLvEUgWK4o0r2WW2IzBrMQEn'
+  config.access_token = 'put your access_token here !'
+end

data/lib/orange_sms.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'orange_sms/version'
+require 'orange_sms/client'
+require 'orange_sms/error'
+require 'active_support/core_ext/module/attribute_accessors'
+
+module OrangeSms
+  mattr_accessor :sender_name
+  @@sender_name = nil
+
+  mattr_accessor :sender_phone
+  @@sender_phone = nil
+
+  mattr_accessor :sender_country_code
+  @@sender_country_code = :sen
+
+  mattr_accessor :authorization
+  @@authorization = nil
+
+  mattr_accessor :default_receiver_country_code
+  @@default_receiver_country_code = :sen
+
+  mattr_accessor :access_token
+  @@access_token = nil
+
+  mattr_reader :base_url
+  @@base_url = 'https://api.orange.com'
+
+  # Setup the Gem
+  def self.setup
+    yield self
+  end
+end

data/lib/orange_sms/client.rb

@@ -0,0 +1,77 @@
+require 'faraday'
+
+module OrangeSms
+  # Orange Api Client used to send http request to the Orange Backend
+  class Client
+    attr_reader :country_code, :country, :sender_phone
+
+    SUPPORTED_COUNTRIES = {
+      sen: { country: 'Senegal', code: 'SEN', prefix: 'tel:+221' },
+      mli: { country: 'Mali', code: 'MLI', prefix: 'tel:+223' },
+      bwa: { country: 'Botswana', code: 'BWA', prefix: 'tel:+267' },
+      bfa: { country: 'Burkina Faso', code: 'BFA', prefix: 'tel:+226' },
+      cod: { country: 'DR Congo', code: 'COD', prefix: 'tel:+243' },
+      civ: { country: "Côte d'Ivoire / Ivory Coast", code: 'CIV', prefix: 'tel:+225' },
+      egy: { country: 'Egypt', code: 'EGY', prefix: 'tel:+200' },
+      jor: { country: 'Jordan', code: 'JOR', prefix: 'tel:+962' },
+      gin: { country: 'Guinea Conakry', code: 'GIN', prefix: 'tel:+224' },
+      ner: { country: 'Niger', code: 'NER', prefix: 'tel:+227' },
+      tun: { country: 'Tunisia', code: 'TUN', prefix: 'tel:+216' },
+      cmr: { country: 'Cameroon', code: 'CMR', prefix: 'tel:+237' }
+    }.freeze
+
+    def initialize(country_code = nil)
+      @country_code = country_code.nil? ? OrangeSms.default_receiver_country_code : country_code
+      @country = SUPPORTED_COUNTRIES[@country_code]
+      @sender_country = SUPPORTED_COUNTRIES[OrangeSms.sender_country_code]
+      @sender_phone = @sender_country[:prefix] + OrangeSms.sender_phone
+    end
+
+    # Fetch the access token directly from your code
+    def fetch_access_token
+      response = send_request('/oauth/v2/token',
+                              'grant_type=client_credentials',
+                              OrangeSms.authorization,
+                              'application/x-www-form-urlencoded')
+      raise OrangeSms::Error::AuthenticationError.new('Unable to fetch access token', response) if response.status != 200
+
+      JSON.parse(response.body).fetch('access_token', nil)
+    end
+
+    # Ask Orange backend to send test message to the sender_phone defined in the /config/initializer/orange_sms.rb
+    def send_test_sms
+      send_sms(OrangeSms.sender_phone, "Yes ! it's working")
+    end
+
+    # Ask Orange backend to send Sms to some number
+    def send_sms(receiver_phone, message)
+      response = send_request("/smsmessaging/v1/outbound/#{sender_phone}/requests",
+                              build_sms_payload(receiver_phone, message),
+                              "Bearer #{OrangeSms.access_token}", 'application/json')
+      raise OrangeSms::Error::ApiError.new('Unable to Send message', response) if response.status != 201
+    end
+
+    private
+
+    # Send a request
+    def send_request(partial_url, payload, authorization_header, content_type)
+      Faraday.post(OrangeSms.base_url + partial_url,
+                   payload,
+                   { 'Authorization' => authorization_header, 'Content-type' => content_type })
+    end
+
+    # Build the payload that gonna be sended
+    def build_sms_payload(receiver_phone, message)
+      {
+        outboundSMSMessageRequest: {
+          address: country[:prefix] + receiver_phone,
+          senderName: OrangeSms.sender_name,
+          senderAddress: sender_phone,
+          outboundSMSTextMessage: {
+            message: message
+          }
+        }
+      }.to_json
+    end
+  end
+end

data/lib/orange_sms/error.rb

@@ -0,0 +1,58 @@
+module OrangeSms
+  module Error
+    class AuthenticationError < StandardError
+      attr_reader :message, :response, :status, :more_info, :error_message
+
+      def initialize(message, response)
+        @status = response.status
+        body = JSON.parse(response.body)
+        @error_message = body.fetch('error', nil)
+        @more_info = body.fetch('error_description', nil)
+        @message = format_message(message)
+        @response = response
+      end
+
+      def to_s
+        message
+      end
+
+      private
+
+      def format_message(initial_message)
+        message = "[HTTP #{status}] #{initial_message}"
+        message += "\n#{error_message}" if error_message
+        message += "\n#{more_info}" if more_info
+        message += '\n For more details on Orange Authentication errors see https://developer.orange.com/tech_guide/2-legged-oauth/'
+        message + "\n\n"
+      end
+    end
+
+    class ApiError < StandardError
+      attr_reader :code, :message, :response, :status, :error_message, :description
+
+      def initialize(message, response)
+        @status = response.status
+        body = JSON.parse(response.body)
+        @code = body.fetch('code', nil)
+        @error_message = body.fetch('message', nil)
+        @description = body.fetch('description', nil)
+        @message = format_message(message)
+        @response = response
+      end
+
+      def to_s
+        message
+      end
+
+      private
+
+      def format_message(initial_message)
+        message = "[HTTP #{status}] #{code} : #{initial_message}"
+        message += "\n#{error_message}" if error_message
+        message += "\n#{description}" if description
+        message += '\n For more details on Orange Api errors see https://developer.orange.com/apis/sms-sn/api-reference'
+        message + "\n\n"
+      end
+    end
+  end
+end

data/lib/orange_sms/version.rb

@@ -0,0 +1,3 @@
+module OrangeSms
+  VERSION = '0.1.0'.freeze
+end

data/orange_sms.gemspec

@@ -0,0 +1,32 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'orange_sms/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'orange_sms'
+  spec.version       = OrangeSms::VERSION
+  spec.authors       = ['Serigne Mouhamadou Bassirou Diaby']
+
+  spec.summary       = 'ruby client that allows to send sms via the orange api'
+  spec.homepage      = 'https://github.com/bayevels/orange-sms-ruby'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'faraday', '>= 0.9', '< 2.0'
+
+  # Development dependencies
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rails', '~> 5.2.0'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'simplecov-small-badge'
+  spec.add_development_dependency 'sprockets', '3.7.2'
+  spec.add_development_dependency 'webmock'
+end

data/script/travis.sh

@@ -0,0 +1,15 @@
+#!/bin/sh
+set -e
+QUICK=${QUICK:-}
+
+if [ -z "$QUICK" ]; then
+  gem install bundler-audit && bundle-audit update && bundle-audit check
+  bundle exec rake
+  # only move to the gh-pages if not a PR or branch is master
+  if [ "$TRAVIS_PULL_REQUEST" = "false" ] || [ "$TRAVIS_BRANCH" = "master" ]; then
+    echo "Pushing badges upstream"
+    [ -d badges ] || mkdir badges
+    cp coverage/coverage_badge* badges/ 2>/dev/null || true
+  fi
+
+fi

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: orange_sms
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Serigne Mouhamadou Bassirou Diaby
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-08-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-small-badge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.7.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.7.2
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/orange_sms/USAGE
+- lib/generators/orange_sms/install_generator.rb
+- lib/generators/orange_sms/templates/orange_sms.rb
+- lib/orange_sms.rb
+- lib/orange_sms/client.rb
+- lib/orange_sms/error.rb
+- lib/orange_sms/version.rb
+- orange_sms.gemspec
+- script/travis.sh
+homepage: https://github.com/bayevels/orange-sms-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: ruby client that allows to send sms via the orange api
+test_files: []