infobip-sms-api-ruby 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b43de03c663f60a25eb989911f0f548fc26ed4c
-  data.tar.gz: feacbdb85e2e9d47d7f828f02f3da9de30967c3c
+  metadata.gz: cb72709a2d68d2a67e06aef08e15ccd66628162a
+  data.tar.gz: 67ffd78696bcd9c9172fe51e75516d2b818d8ecb
 SHA512:
-  metadata.gz: 1739314c789b282392845ca7dd4db45101f450e256880f492a0bd4c321ab34a366f795f25aaf2e37f956b83757bb360485f3545b8e4ccc3a4f0d82a08ec44ae7
-  data.tar.gz: de3e98178f876fd798da37e3872d57e9702f7ee4e1fe36d8cf8030defb8a6222732583ad2182f51d7f64321985a551a7caca3ca12475d450f4247e9734a1d20a
+  metadata.gz: a01acaa5d2f787f077bbc13944764b97108e0e397a5686a9f17c37f6d94b7feaac59e3ebd7bfc8c436d8c097bac9fd31c13035f84fd2c0f3c4ff9fd78adae214
+  data.tar.gz: 5c0e17e93153427762672df1cb7f052f8f65f88f6f54e3a5ac89cbe918e2f401244016a316e3e1a20c8252e9551a9c9e2965138b1554ccb9f945a1077e5b9f86

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v '~> 1.11'

data/README.md

@@ -1,6 +1,13 @@
 # infobip-sms-api-ruby
 
-Simple API wrapper for Infobip SMS Api
+[![Build Status](https://travis-ci.org/dkocic/infobip-sms-api-ruby.png)](https://travis-ci.org/dkocic/infobip-sms-api-ruby)
+[![Coverage Status](https://coveralls.io/repos/github/dkocic/infobip-sms-api-ruby/badge.svg?branch=master)](https://coveralls.io/github/dkocic/infobip-sms-api-ruby?branch=master)
+
+Simple API wrapper for Infobip SMS Api (https://dev.infobip.com/)
+
+Notes: 
+**This is not offical infobip release**, it's a personal project started because there is no other solution ATM.
+
 
 ## Installation
 
@@ -41,18 +48,51 @@ To successfully use this gem you need to have Infobip account, and you need to s
 
 ## Usage
 
-### Send single textual message
-```ruby
-message = Infobip::SmsApi::Message.new(from: 'Sender', to: '381650000000', text: "Lorem ipsum...")
-response = message.send_text
-```
+```ruby  
+
+text_message = Infobip::SmsApi::TextMessage.new(
+  from: 'Sender', 
+  to: '31630000000', 
+  text: "Lorem ipsum...")  
+
+another_text_message = Infobip::SmsApi::TextMessage.new(
+  from: 'Sender', 
+  to: ['31630000000', '31630000001'], 
+  text: "Lorem ipsum...")  
+  
+binary_message = Infobip::SmsApi::BinaryMessage.new(
+  from:'binary', 
+  to: '31630000000', 
+  binary: {
+    hex: '54 65 73 74 20 6d 65 73 73 61 67 65 2e',
+    data_coding: 0,
+    esm_class: 0
+  })
+
+another_binary_message = Infobip::SmsApi::BinaryMessage.new(
+  from:'binary2', 
+  to: ['31630000000', '31630000001'], 
+  binary: {
+    hex: '54 65 73 74 20 6d 65 73 73 61 67 65 2e',
+    data_coding: 0,
+    esm_class: 0
+  })
+
+# Send single text sms message
+response = Infobip::SmsApi.deliver(text_message)  
+# Send multiple text sms messages
+response = Infobip::SmsApi.deliver(text_message, another_text_message)  
+
+# Send single binary sms message
+response = Infobip::SmsApi.deliver(binary_message)  
+# Send multiple binary sms messages
+response = Infobip::SmsApi.deliver(binary_message, another_binary_message)  
+
+success = response.successful?
 
-### Send single textual message to multiple destinations
-```ruby
-message = Infobip::SmsApi::Message.new(from: 'Sender', to: ['381650000000','381650000001'], text: "Lorem ipsum...")
-response = message.send_text
 ```
 
+
 ## 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.

data/Rakefile

@@ -1,2 +1,8 @@
 require "bundler/gem_tasks"
-task :default => :spec
+require 'rake/testtask'
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/**/*_test.rb"
+end

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "infobip/sms/api/ruby"
+require "infobip/sms_api"
 
 # 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.

data/infobip-sms-api-ruby.gemspec

@@ -24,6 +24,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "minitest", "~> 5.8"
   spec.add_development_dependency "vcr", "~> 3.0"
   spec.add_development_dependency "webmock", "~> 1.24"
+  spec.add_development_dependency "simplecov", "~> 0.11"
+  spec.add_development_dependency "rails", "~> 5.0.0.beta3"
+  spec.add_development_dependency "coveralls", "~> 0"
 
   spec.add_dependency "faraday", "~> 0.9"
   spec.add_dependency "json", "~> 1.8"

data/lib/infobip/sms_api.rb

@@ -1,8 +1,13 @@
 require 'infobip/sms_api/version'
+require 'infobip/sms_api/errors'
 require 'infobip/sms_api/message'
+require 'infobip/sms_api/messages'
 require 'infobip/sms_api/response'
 require 'infobip/sms_api/configuration'
-
+require 'infobip/sms_api/model/base'
+require 'infobip/sms_api/model/text_message'
+require 'infobip/sms_api/model/binary_message'
+require 'infobip/sms_api/model/binary_data'
 module Infobip
   module SmsApi
 
@@ -19,5 +24,14 @@ module Infobip
       configuration.connect
     end
 
+    def self.deliver(*messages)
+      raise RequiredArgumentMissingError, 'At least 1 message should be sent' if messages.size == 0
+      if messages.size == 1
+        Infobip::SmsApi::Messages.send_single(messages.first)
+      else
+        Infobip::SmsApi::Messages.send_multiple(messages)
+      end
+    end
+
   end
 end

data/lib/infobip/sms_api/errors.rb

@@ -0,0 +1,12 @@
+module Infobip
+  module SmsApi
+    class InfobipStandardError < StandardError
+    end
+    class RequiredArgumentMissingError < InfobipStandardError
+    end
+    class UnknownArgumentError < InfobipStandardError
+    end
+    class MalformedArgumentError < InfobipStandardError
+    end
+  end
+end

data/lib/infobip/sms_api/messages.rb

@@ -0,0 +1,65 @@
+module Infobip
+  module SmsApi
+    module Messages
+
+      def self.send_single(message)
+        if message.class == Infobip::SmsApi::TextMessage
+          return send_single_text_message message
+        elsif message.class == Infobip::SmsApi::BinaryMessage
+          return send_single_binary_message message
+        else
+          raise UnknownArgumentError, "Unknown message type: #{message.class}"
+        end
+      end
+
+      def self.send_multiple(messages)
+        return send_multiple_text_messages messages if valid_messages?(messages, Infobip::SmsApi::TextMessage)
+        return send_multiple_binary_messages messages if valid_messages?(messages, Infobip::SmsApi::BinaryMessage)
+        raise MalformedArgumentError, 'When sending multiple messages, all messages need to be of the same type'
+      end
+
+      def self.valid_messages?(messages, object_class)
+        messages.all? do |message|
+          message.class == object_class
+        end
+      end
+
+      def self.send_single_text_message(message)
+        post_single(Infobip::SmsApi::TextMessage, '/sms/1/text/single', message)
+      end
+
+      def self.send_single_binary_message(message)
+        post_single(Infobip::SmsApi::BinaryMessage, '/sms/1/binary/single', message)
+      end
+
+      def self.send_multiple_text_messages(messages)
+        post_multi('/sms/1/text/multi', messages)
+      end
+
+      def self.send_multiple_binary_messages(messages)
+        post_multi('/sms/1/binary/multi', messages)
+      end
+
+      def self.post_single(class_name, endpoint, message)
+        raise UnknownArgumentError, "Unsupported Message Type: #{message.class}" unless message.class == class_name
+        response = self.post(endpoint, message)
+        Response::Base.new(response.status, JSON.parse(response.body))
+      end
+
+      def self.post_multi(endpoint, messages)
+        response = self.post(endpoint, { messages: messages.map(&:to_hash) })
+        Response::Base.new(response.status, JSON.parse(response.body))
+      end
+
+      def self.post(url, body)
+        Infobip::SmsApi.configuration.connection.post do |req|
+          req.url url
+          req.body = body.to_json
+          req.headers['Accept'] = 'application/json'
+          req.headers['Content-Type'] = 'application/json'
+        end
+      end
+
+    end
+  end
+end

data/lib/infobip/sms_api/model/base.rb

@@ -0,0 +1,22 @@
+require 'json'
+
+module Infobip
+  module SmsApi
+    class Base
+
+      def to_hash
+        hash = {}
+        self.instance_variables.each do |var|
+          value = self.instance_variable_get(var)
+          hash[var.to_s.delete('@')] = value.respond_to?(:to_hash) ? value.to_hash : value
+        end
+        hash
+      end
+
+      def to_json
+        self.to_hash.to_json
+      end
+
+    end
+  end
+end

data/lib/infobip/sms_api/model/binary_data.rb

@@ -0,0 +1,15 @@
+require 'infobip/sms_api/model/base'
+module Infobip
+  module SmsApi
+    class BinaryData < Base
+
+      attr_accessor :hex, :data_coding, :esm_class
+
+      def initialize(attributes)
+        @hex = attributes[:hex]
+        @data_coding = attributes[:data_coding]
+        @esm_class = attributes[:esm_class]
+      end
+    end
+  end
+end

data/lib/infobip/sms_api/model/binary_message.rb

@@ -0,0 +1,15 @@
+module Infobip
+  module SmsApi
+    class BinaryMessage < Base
+
+      attr_accessor :from, :to, :binary
+
+      def initialize(attributes)
+        @from = attributes[:from]
+        @to = attributes[:to]
+        @binary = BinaryData.new(attributes[:binary])
+      end
+
+    end
+  end
+end

data/lib/infobip/sms_api/model/text_message.rb

@@ -0,0 +1,16 @@
+require 'infobip/sms_api/model/binary_data'
+module Infobip
+  module SmsApi
+    class TextMessage < Base
+
+      attr_accessor :from, :to, :text
+
+      def initialize(attributes)
+        @from = attributes[:from]
+        @to = attributes[:to]
+        @text = attributes[:text]
+      end
+
+    end
+  end
+end

data/lib/infobip/sms_api/response.rb

@@ -1,6 +1,8 @@
 require 'infobip/sms_api/response/base'
 require 'infobip/sms_api/response/message'
 require 'infobip/sms_api/response/status'
+require 'infobip/sms_api/response/request_error'
+require 'infobip/sms_api/response/service_exception'
 module Infobip
   module SmsApi
     module Response

data/lib/infobip/sms_api/response/base.rb

@@ -14,9 +14,8 @@ module Infobip
               attributes['messages'].each do |message|
                 @messages << Infobip::SmsApi::Response::Message.new(message)
               end
-            when 401
-              @request_error = attributes['requestError']
             else
+              @request_error = Infobip::SmsApi::Response::RequestError.new(attributes['requestError'])
           end
         end
 
@@ -31,7 +30,7 @@ module Infobip
         def failed_messages
           @messages.select { |message|
             !SUCCESSFUL_STATUSES.include?message.status.group_name
-          }
+          } if @messages
         end
 
         ##
@@ -39,7 +38,7 @@ module Infobip
         def sent_messages
           @messages.select { |message|
             SUCCESSFUL_STATUSES.include?message.status.group_name
-          }
+          } if @messages
         end
       end
     end

data/lib/infobip/sms_api/response/request_error.rb

@@ -0,0 +1,12 @@
+module Infobip
+  module SmsApi
+    module Response
+      class RequestError
+        attr_reader :service_exception
+        def initialize(attributes)
+          @service_exception = attributes['serviceException']
+        end
+      end
+    end
+  end
+end

data/lib/infobip/sms_api/response/service_exception.rb

@@ -0,0 +1,16 @@
+module Infobip
+  module SmsApi
+    module Response
+      class ServiceException
+
+        attr_reader :message_id, :text
+
+        def initialize(attributes)
+          @message_id = attributes['messageId']
+          @text = attributes['text']
+        end
+
+      end
+    end
+  end
+end

data/lib/infobip/sms_api/version.rb

@@ -1,5 +1,5 @@
 module Infobip
   module SmsApi
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: infobip-sms-api-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - dkocic
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-09 00:00:00.000000000 Z
+date: 2016-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.24'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0.beta3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0.beta3
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -116,6 +158,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -123,18 +166,23 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- fixtures/test_single_missing_to.yml
-- fixtures/test_single_network_rejected.yml
-- fixtures/test_single_pending.yml
 - infobip-sms-api-ruby.gemspec
 - lib/generators/infobip/config/config_generator.rb
 - lib/generators/infobip/config/templates/config.rb
 - lib/infobip/sms_api.rb
 - lib/infobip/sms_api/configuration.rb
+- lib/infobip/sms_api/errors.rb
 - lib/infobip/sms_api/message.rb
+- lib/infobip/sms_api/messages.rb
+- lib/infobip/sms_api/model/base.rb
+- lib/infobip/sms_api/model/binary_data.rb
+- lib/infobip/sms_api/model/binary_message.rb
+- lib/infobip/sms_api/model/text_message.rb
 - lib/infobip/sms_api/response.rb
 - lib/infobip/sms_api/response/base.rb
 - lib/infobip/sms_api/response/message.rb
+- lib/infobip/sms_api/response/request_error.rb
+- lib/infobip/sms_api/response/service_exception.rb
 - lib/infobip/sms_api/response/status.rb
 - lib/infobip/sms_api/version.rb
 homepage: https://github.com/dkocic/infobip-sms-api-ruby

data/fixtures/test_single_missing_to.yml

@@ -1,45 +0,0 @@
----
-http_interactions:
-- request:
-    method: post
-    uri: https://test:test@api.infobip.com/sms/1/text/single
-    body:
-      encoding: UTF-8
-      string: '{"from":"Test","to":"","text":"Testing"}'
-    headers:
-      User-Agent:
-      - Faraday v0.9.2
-      Accept:
-      - application/json
-      Content-Type:
-      - application/json
-      Accept-Encoding:
-      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
-  response:
-    status:
-      code: 401
-      message: Unauthorized
-    headers:
-      Access-Control-Allow-Origin:
-      - "*"
-      Access-Control-Allow-Methods:
-      - GET, POST, PUT, PATCH, DELETE, COPY, HEAD, OPTIONS, LINK, UNLINK, PURGE
-      Access-Control-Allow-Headers:
-      - Authorization, Content-Type, X-Enrollment-Token
-      Content-Type:
-      - application/json;charset=UTF-8
-      Content-Length:
-      - '97'
-      Date:
-      - Wed, 09 Mar 2016 19:11:58 GMT
-      Connection:
-      - close
-      Server:
-      - SMS API
-    body:
-      encoding: UTF-8
-      string: '{"requestError":{"serviceException":{"messageId":"UNAUTHORIZED","text":"Invalid
-        login details"}}}'
-    http_version: 
-  recorded_at: Wed, 09 Mar 2016 19:11:58 GMT
-recorded_with: VCR 3.0.1

data/fixtures/test_single_network_rejected.yml

@@ -1,45 +0,0 @@
----
-http_interactions:
-- request:
-    method: post
-    uri: https://test:test@api.infobip.com/sms/1/text/single
-    body:
-      encoding: UTF-8
-      string: '{"from":"Test","to":"381203136825","text":"Testing"}'
-    headers:
-      User-Agent:
-      - Faraday v0.9.2
-      Accept:
-      - application/json
-      Content-Type:
-      - application/json
-      Accept-Encoding:
-      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
-  response:
-    status:
-      code: 401
-      message: Unauthorized
-    headers:
-      Access-Control-Allow-Origin:
-      - "*"
-      Access-Control-Allow-Methods:
-      - GET, POST, PUT, PATCH, DELETE, COPY, HEAD, OPTIONS, LINK, UNLINK, PURGE
-      Access-Control-Allow-Headers:
-      - Authorization, Content-Type, X-Enrollment-Token
-      Content-Type:
-      - application/json;charset=UTF-8
-      Content-Length:
-      - '97'
-      Date:
-      - Wed, 09 Mar 2016 19:11:58 GMT
-      Connection:
-      - close
-      Server:
-      - SMS API
-    body:
-      encoding: UTF-8
-      string: '{"requestError":{"serviceException":{"messageId":"UNAUTHORIZED","text":"Invalid
-        login details"}}}'
-    http_version: 
-  recorded_at: Wed, 09 Mar 2016 19:11:58 GMT
-recorded_with: VCR 3.0.1

data/fixtures/test_single_pending.yml

@@ -1,45 +0,0 @@
----
-http_interactions:
-- request:
-    method: post
-    uri: https://test:test@api.infobip.com/sms/1/text/single
-    body:
-      encoding: UTF-8
-      string: '{"from":"Test","to":"31633136825","text":"Testing"}'
-    headers:
-      User-Agent:
-      - Faraday v0.9.2
-      Accept:
-      - application/json
-      Content-Type:
-      - application/json
-      Accept-Encoding:
-      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
-  response:
-    status:
-      code: 401
-      message: Unauthorized
-    headers:
-      Access-Control-Allow-Origin:
-      - "*"
-      Access-Control-Allow-Methods:
-      - GET, POST, PUT, PATCH, DELETE, COPY, HEAD, OPTIONS, LINK, UNLINK, PURGE
-      Access-Control-Allow-Headers:
-      - Authorization, Content-Type, X-Enrollment-Token
-      Content-Type:
-      - application/json;charset=UTF-8
-      Content-Length:
-      - '97'
-      Date:
-      - Wed, 09 Mar 2016 19:11:58 GMT
-      Connection:
-      - close
-      Server:
-      - SMS API
-    body:
-      encoding: UTF-8
-      string: '{"requestError":{"serviceException":{"messageId":"UNAUTHORIZED","text":"Invalid
-        login details"}}}'
-    http_version: 
-  recorded_at: Wed, 09 Mar 2016 19:11:58 GMT
-recorded_with: VCR 3.0.1