infobeep 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 579c6166aa3d343621867ac8f318194689360665
+  data.tar.gz: 7d1d88e6da3830dcf223076381f4f0fc66f073f8
+SHA512:
+  metadata.gz: 464f148aad810295414e9e0e440f2ffadee2f41f6bf734dc266c00784fe7294b260483201701fedfafcbbc7f887ccea2f7fe73b37345fb1a21234600732e49b6
+  data.tar.gz: 7f954f622cf01d56d1449a3122cb477f828357c30e9c7be1c63e0d7d601f14ec1190df32499a6299609d67a589694c98e19e35c896cc5f72f876f22ba7451109

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 infobeep.gemspec
+gemspec
+
+gem 'virtus'
+gem 'rest-client'

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,37 @@
+# Infobeep
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'infobeep'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install infobeep
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/infobeep. 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/bin/console

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

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'infobeep/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "infobeep"
+  spec.version       = Infobeep::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/infobeep"
+  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/lib/infobeep/client.rb

@@ -0,0 +1,54 @@
+require 'base64'
+require 'json'
+require 'rest-client'
+
+module Infobeep
+
+  class BaseClient
+    API_BASE_URL = 'https://api.infobip.com/'
+
+    def initialize(username, password)
+      @username = username
+      @password = password
+    end
+
+    def authentication_headers
+      auth_string = ::Base64.encode64("#{@username}:#{@password}").strip
+      {'Authorization': "Basic #{auth_string}"}
+    end
+
+    def client_headers
+      hsh = {
+          'User-Agent': "Infobeep-#{Infobeep::VERSION}",
+          'Content-Type': 'application/json',
+          'accept': 'application/json'
+      }
+      hsh.merge!(authentication_headers)
+      hsh
+    end
+
+  end
+
+
+  class SMSClient < BaseClient
+    SMS_API_BASE_URL = "#{API_BASE_URL}sms/1/"
+
+    def send_request(sms_request)
+      url = SMS_API_BASE_URL + sms_request.route
+      method = sms_request.http_method
+      headers = client_headers.merge(sms_request.headers)
+      payload = sms_request.payload
+
+      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
+
+  end
+
+end

data/lib/infobeep/models.rb

@@ -0,0 +1,91 @@
+require 'json'
+
+module Infobeep
+
+  class Model
+    include ::Virtus.model
+
+    def hash_attributes
+      attributes
+    end
+  end
+
+  class SMSRequestDestination < Model
+    attribute :messageId, String
+    attribute :to, String
+  end
+
+  class Status < Model
+    attribute :id, Integer
+    attribute :groupId, Integer
+    attribute :groupName, String
+    attribute :name, String
+    attribute :description, String
+  end
+
+  class Error < Model
+    attribute :id, Integer
+    attribute :groupId, Integer
+    attribute :groupName, String
+    attribute :name, String
+    attribute :description, String
+    attribute :permanent, Boolean
+  end
+
+  class Price < Model
+    attribute :pricePerMessage, BigDecimal
+    attribute :currency, String
+  end
+
+  class SMSResponseDetail < Model
+    attribute :to, String
+    attribute :status, Status
+    attribute :smsCount, Integer
+    attribute :messageId, String
+  end
+
+  class SMSResponse < Model
+    attribute :bulkId, String
+    attribute :messages, Array[SMSResponseDetail]
+  end
+
+  class SentSMSLog < Model
+    attribute :bulkId, String
+    attribute :messageId, String
+    attribute :to, String
+    attribute :from, String
+    attribute :text, String
+    attribute :sentAt, DateTime
+    attribute :doneAt, DateTime
+    attribute :smsCount, Integer
+    attribute :mccmnc, String
+    attribute :price, Price
+    attribute :status, Status
+    attribute :error, Error
+
+  end
+
+  class SentSMSReport < Model
+    attribute :bulkId, String
+    attribute :messageId, String
+    attribute :to, String
+    attribute :from, String
+    attribute :text, String
+    attribute :sentAt, DateTime
+    attribute :doneAt, DateTime
+    attribute :smsCount, Integer
+    attribute :mccMnc, String
+    attribute :price, Price
+    attribute :status, Status
+    attribute :error, Error
+  end
+
+  class SMSLOGSRESPONSE < Model
+    attribute :results, Array[SentSMSLog]
+  end
+
+  class SMSReportResponse < Model
+    attribute :results, Array[SentSMSLog]
+  end
+
+end

data/lib/infobeep/requests/base_request_model.rb

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

data/lib/infobeep/requests/bulk_sms_request.rb

@@ -0,0 +1,27 @@
+require 'json'
+
+module Infobeep
+  class BulkSMSRequest < BaseRequestModel
+    attribute :bulkId, String
+    attribute :messages, Array[SMSRequest]
+
+    def hash_attributes
+      h = super
+      h[:messages] = messages.collect{ |message| message.hash_attributes }
+      h
+    end
+
+    def http_method
+      :post
+    end
+
+    def route
+      'text/advanced'
+    end
+
+    def response_class
+      SMSResponse
+    end
+  end
+
+end

data/lib/infobeep/requests/sms_log_request.rb

@@ -0,0 +1,28 @@
+require 'json'
+
+module Infobeep
+  class SMSLogRequest < BaseRequestModel
+    attribute :from, String
+    attribute :to, String
+    attribute :bulkId, String
+    attribute :messageId, String
+    attribute :generalStatus, String
+    attribute :sentSince, DateTime
+    attribute :sentUntil, DateTime
+    attribute :limit, Integer
+    attribute :mcc, String
+    attribute :mnc, String
+
+    def http_method
+      :get
+    end
+
+    def route
+      'logs'
+    end
+
+    def response_class
+      SMSLOGSRESPONSE
+    end
+  end
+end

data/lib/infobeep/requests/sms_report_request.rb

@@ -0,0 +1,22 @@
+require 'json'
+
+module Infobeep
+  class SMSReportRequest < BaseRequestModel
+    attribute :bulkId, String
+    attribute :messageId, String
+    attribute :limit, Integer
+
+    def http_method
+      :get
+    end
+
+    def route
+      'reports'
+    end
+
+    def response_class
+      SMSReportResponse
+    end
+
+  end
+end

data/lib/infobeep/requests/sms_request.rb

@@ -0,0 +1,45 @@
+require 'json'
+
+module Infobeep
+  class SMSRequest < BaseRequestModel
+    attribute :from, String
+    attribute :to, Array[String]
+    attribute :destinations, Array[SMSRequestDestination]
+    attribute :text, String
+    attribute :notifyUrl, String
+    attribute :notifyContentType, String, default: 'application/json'
+    attribute :callbackData, String
+    attribute :intermediateReport, Boolean, default: false
+
+
+    def hash_attributes
+      h = super
+      h[:destinations] = []
+      h[:destinations] =  h[:destinations] + destinations.collect{ |destination| destination.hash_attributes }
+      unless to.empty?
+        h[:destinations] << {to: to}
+      end
+      h.delete(:to)
+      h
+    end
+
+    def route
+      'text/advanced'
+    end
+
+    def http_method
+      :post
+    end
+
+    def payload
+      bulk_sms_request = Infobeep::BulkSMSRequest.new
+      bulk_sms_request.messages = [self]
+      bulk_sms_request.payload
+    end
+
+    def response_class
+      SMSResponse
+    end
+
+  end
+end

data/lib/infobeep/requests.rb

@@ -0,0 +1,5 @@
+require "infobeep/requests/base_request_model"
+require "infobeep/requests/sms_request"
+require "infobeep/requests/bulk_sms_request"
+require "infobeep/requests/sms_log_request"
+require "infobeep/requests/sms_report_request"

data/lib/infobeep/version.rb

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

data/lib/infobeep.rb

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

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: infobeep
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Favourite Onwuemene
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-27 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
+- bin/console
+- bin/setup
+- infobeep.gemspec
+- lib/infobeep.rb
+- lib/infobeep/client.rb
+- lib/infobeep/models.rb
+- lib/infobeep/requests.rb
+- lib/infobeep/requests/base_request_model.rb
+- lib/infobeep/requests/bulk_sms_request.rb
+- lib/infobeep/requests/sms_log_request.rb
+- lib/infobeep/requests/sms_report_request.rb
+- lib/infobeep/requests/sms_request.rb
+- lib/infobeep/version.rb
+homepage: https://github.com/favour121/infobeep
+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: Infobip (infobip.com) Ruby API.
+test_files: []