clickatell_api_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 27d57e8f04227a482256abb32670b04302de7682
+  data.tar.gz: e9977ec3948d55f54185708902960c33cc5c26b2
+SHA512:
+  metadata.gz: 0b1699333e04593768b1e78545f65a66593d66fbd2b97b35e9df189b203c55f98cf4c0838c0e01ee1254c6c45227a29965e7e7f2b445fecc2a7eea6c097aad65
+  data.tar.gz: f6a91e976fa82d7266c9bc722d953d8bd5fae6ca15af77375a6bddf5a91dfe1f725e116dcbe63290312944596f3b97eb4fb055a1e0f8ed62933bb49af8d302c1

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+*.gem

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.4

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in clickatell_api_client.gemspec
+gemspec

data/README.md

@@ -0,0 +1,74 @@
+# ClickatellApiClient
+
+Ruby gem which is a wrapper for [Clickatell](https://www.clickatell.com/) API.
+It allows to send a message and supports sending messages to the US (two way message) and to the rest of the World.
+Gem automatically check if a number is from the USA and which type of a message should be used (two way or not).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'clickatell_api_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install clickatell_api_client
+
+## Configuration
+
+First of all, configure your client.
+
+```ruby
+ClickatellApiClient.configure do |config|
+  config.api_key = '123'
+  config.us_api_key = '234'
+  config.phone_number '+1324324231'
+end
+```
+
+- `api_key` - your API key for non-two way messages
+- `us_api_key` - your API key for two way messages (US only)
+- `phone_number` - your phone number from Clickatell which is used to send a two way message
+
+## Usage
+
+In order to send a message, just use:
+
+```ruby
+ClickatellApiClient::API::SendMessage.new(
+  telephone: '+1213123213132',
+  message: 'Your message'
+).call
+```
+
+Example response after sending a message:
+```ruby
+{
+  message_id: '32eef0se02ed0fsdasd',
+  to: '+1213123213132',
+  send: 'true'
+}
+```
+
+There is a possiblity, that Clickatell API returns error after trying to send a message. Here is the list of exceptions:
+- `ClickatellApiClient::API::TopUpAccountError` - you don't have enought funds to send a message.
+- `ClickatellApiClient::API::MissingFromNumberError` - missing sender number (used in two way messages)
+- `ClickatellApiClient::API::InvalidAPIResponseError` - other API error
+
+That's all!
+
+## 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/paladinsoftware/clickatell_api_client. 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.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "clickatell_api_client/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "clickatell_api_client"
+  spec.version       = ClickatellApiClient::VERSION
+  spec.authors       = ["Piotr Jaworski"]
+  spec.email         = ["piotrek.jaw@gmail.com"]
+
+  spec.summary       = %q{Clickatell API Ruby wrapper.}
+  spec.description   = %q{Gem which is a wrapper written in Ruby for Clickatell API.}
+  spec.homepage      = "https://github.com/paladinsoftware/clickatell_api_client"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_runtime_dependency "faraday", "~> 0.15"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/clickatell_api_client/api/client.rb

@@ -0,0 +1,63 @@
+module ClickatellApiClient
+  module API
+    class ClickatellAPIError < StandardError; end
+    class TopUpAccountError < ClickatellAPIError; end
+    class MissingFromNumberError < ClickatellAPIError; end
+    class InvalidAPIResponseError < ClickatellAPIError; end
+
+    class Client
+      NO_ERROR = 200
+      ERROR_MISSING_FROM_NUMBER = 106
+      ERROR_TOP_UP_ACCOUNT = 301
+
+      PROVIDER_URL = 'https://platform.clickatell.com'.freeze
+      MESSAGES_ENDPOINT = '/messages'.freeze
+
+      attr_reader :api_key
+
+      def initialize(api_key)
+        @api_key = api_key
+      end
+
+      def send_message(params)
+        request(
+          http_method: :post,
+          endpoint: MESSAGES_ENDPOINT,
+          params: params
+        )
+      end
+
+      private
+
+      def connection
+        @_connection ||= Faraday.new(url: PROVIDER_URL) do |client|
+          client.request :url_encoded
+          client.adapter Faraday.default_adapter
+          client.headers['Authorization'] = api_key
+        end
+      end
+
+      def request(http_method:, endpoint:, params:)
+        response = connection.public_send(http_method, endpoint, **params)
+        error_code = JSON.parse(response.body)['errorCode']
+
+        return response if successful_response?(error_code)
+
+        error_class = case error_code
+                      when ERROR_TOP_UP_ACCOUNT
+                        TopUpAccountError
+                      when ERROR_MISSING_FROM_NUMBER
+                        MissingFromNumberError
+                      else
+                        InvalidAPIResponseError
+                      end
+
+        raise Object.const_get("::ClickatellApiClient::API::#{error_class}"), "Code: #{error_code}, response: #{response.body}"
+      end
+
+      def successful_response?(code)
+        code.to_i == NO_ERROR || code.nil?
+      end
+    end
+  end
+end

data/lib/clickatell_api_client/api/send_message.rb

@@ -0,0 +1,60 @@
+module ClickatellApiClient
+  module API
+    class SendMessage
+      attr_reader :telephone, :message
+
+      def initialize(telephone:, message:)
+        @telephone = telephone
+        @message = message
+      end
+
+      def call
+        response = client.send_message(sms_attributes)
+        response_body = JSON.parse(response.body)
+
+        response_data(response_body)
+      end
+
+      private
+
+      def client
+        @_client = Client.new(api_key)
+      end
+
+      def api_key
+        if us_phone_number?
+          ClickatellApiClient.configuration.us_api_key
+        else
+          ClickatellApiClient.configuration.api_key
+        end
+      end
+
+      def us_phone_number?
+        @_us_phone_number ||= TelephoneNumber::UsNumberValidator.new(telephone).call
+      end
+
+      def sms_attributes
+        if us_phone_number?
+          default_attributes.merge(from: ClickatellApiClient.configuration.phone_number)
+        else
+          default_attributes
+        end
+      end
+
+      def default_attributes
+        {
+          content: message,
+          to: telephone
+        }
+      end
+
+      def response_data(response_body)
+        {
+          message_id: response_body['messages'].first['apiMessageId'],
+          to: response_body['messages'].first['to'],
+          send: response_body['messages'].first['accepted']
+        }
+      end
+    end
+  end
+end

data/lib/clickatell_api_client/telephone_number/us_number_validator.rb

@@ -0,0 +1,17 @@
+module ClickatellApiClient
+  module TelephoneNumber
+    class UsNumberValidator
+      US_PHONE_NUMBER_REGEXP = /^\+1\d{10}$/
+
+      attr_reader :telephone
+
+      def initialize(telephone)
+        @telephone = telephone
+      end
+
+      def call
+        !!US_PHONE_NUMBER_REGEXP.match(telephone)
+      end
+    end
+  end
+end

data/lib/clickatell_api_client/version.rb

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

data/lib/clickatell_api_client.rb

@@ -0,0 +1,21 @@
+require 'json'
+require 'faraday'
+require 'clickatell_api_client/version'
+require 'clickatell_api_client/telephone_number/us_number_validator'
+require 'clickatell_api_client/api/client'
+require 'clickatell_api_client/api/send_message'
+
+module ClickatellApiClient
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :phone_number, :us_api_key, :api_key
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: clickatell_api_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Piotr Jaworski
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: Gem which is a wrapper written in Ruby for Clickatell API.
+email:
+- piotrek.jaw@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- clickatell_api_client.gemspec
+- lib/clickatell_api_client.rb
+- lib/clickatell_api_client/api/client.rb
+- lib/clickatell_api_client/api/send_message.rb
+- lib/clickatell_api_client/telephone_number/us_number_validator.rb
+- lib/clickatell_api_client/version.rb
+homepage: https://github.com/paladinsoftware/clickatell_api_client
+licenses: []
+metadata: {}
+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.6.12
+signing_key: 
+specification_version: 4
+summary: Clickatell API Ruby wrapper.
+test_files: []