infobip-sms-api-ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7b43de03c663f60a25eb989911f0f548fc26ed4c
+  data.tar.gz: feacbdb85e2e9d47d7f828f02f3da9de30967c3c
+SHA512:
+  metadata.gz: 1739314c789b282392845ca7dd4db45101f450e256880f492a0bd4c321ab34a366f795f25aaf2e37f956b83757bb360485f3545b8e4ccc3a4f0d82a08ec44ae7
+  data.tar.gz: de3e98178f876fd798da37e3872d57e9702f7ee4e1fe36d8cf8030defb8a6222732583ad2182f51d7f64321985a551a7caca3ca12475d450f4247e9734a1d20a

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea/
+*.gem

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 damir@ezyplanet.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 infobip-sms-api-ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Damir Kocic
+
+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,70 @@
+# infobip-sms-api-ruby
+
+Simple API wrapper for Infobip SMS Api
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'infobip-sms-api-ruby'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install infobip-sms-api-ruby
+
+Run generator:
+
+    rails g infobip:config
+    
+Generator will create new file config/initializers/infobip_config.rb:
+
+```ruby
+Infobip::SmsApi.configure do |config|
+
+  # config.endpoint = 'https://api.infobip.com'
+
+  config.username = '' # Infobip Account Username
+  config.password = '' # Infobip Account Password
+
+  # config.debug = false # Log requests and responses
+
+end
+```
+
+To successfully use this gem you need to have Infobip account, and you need to set your username and password.
+
+## Usage
+
+### Send single textual message
+```ruby
+message = Infobip::SmsApi::Message.new(from: 'Sender', to: '381650000000', text: "Lorem ipsum...")
+response = message.send_text
+```
+
+### 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.
+
+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/dkocic/infobip-sms-api-ruby. 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 "infobip/sms/api/ruby"
+
+# 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/fixtures/test_single_missing_to.yml

@@ -0,0 +1,45 @@
+---
+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

@@ -0,0 +1,45 @@
+---
+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

@@ -0,0 +1,45 @@
+---
+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

data/infobip-sms-api-ruby.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'infobip/sms_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "infobip-sms-api-ruby"
+  spec.version       = Infobip::SmsApi::VERSION
+  spec.authors       = ["dkocic"]
+  spec.email         = ["kocicdamir87@gmail.com"]
+
+  spec.summary       = %q{Rails Gem Wrapper for InfoBip SMS API}
+  spec.description   = %q{Rails Gem Wrapper for InfoBip SMS API.}
+  spec.homepage      = "https://github.com/dkocic/infobip-sms-api-ruby"
+  spec.license       = "MIT"
+
+  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.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.8"
+  spec.add_development_dependency "vcr", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 1.24"
+
+  spec.add_dependency "faraday", "~> 0.9"
+  spec.add_dependency "json", "~> 1.8"
+end

data/lib/generators/infobip/config/config_generator.rb

@@ -0,0 +1,11 @@
+module Infobip
+  module Generators
+    class ConfigGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      def generate_config
+        copy_file 'config.rb', 'config/initializers/infobip_config.rb'
+      end
+    end
+  end
+end

data/lib/generators/infobip/config/templates/config.rb

@@ -0,0 +1,10 @@
+Infobip::SmsApi.configure do |config|
+
+  # config.endpoint = 'https://api.infobip.com'
+
+  config.username = '' # Infobip Account Username
+  config.password = '' # Infobip Account Password
+
+  # config.debug = '' # Log requests and responses
+
+end

data/lib/infobip/sms_api.rb

@@ -0,0 +1,23 @@
+require 'infobip/sms_api/version'
+require 'infobip/sms_api/message'
+require 'infobip/sms_api/response'
+require 'infobip/sms_api/configuration'
+
+module Infobip
+  module SmsApi
+
+    class << self
+      attr_writer :configuration
+    end
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.configure
+      yield(configuration)
+      configuration.connect
+    end
+
+  end
+end

data/lib/infobip/sms_api/configuration.rb

@@ -0,0 +1,21 @@
+module Infobip
+  module SmsApi
+    class Configuration
+      attr_accessor :username, :password, :endpoint, :connection, :debug
+
+      def initialize
+        @endpoint = 'https://api.infobip.com'
+        @debug = false
+      end
+
+      def connect
+        raise 'Username and/or password are not configured' unless @username && @password
+        @connection = Faraday.new(url: @endpoint) do |faraday|
+          faraday.adapter :net_http
+          faraday.response :logger if @debug
+        end
+        @connection.basic_auth @username, @password
+      end
+    end
+  end
+end

data/lib/infobip/sms_api/message.rb

@@ -0,0 +1,36 @@
+require 'faraday'
+require 'json'
+
+module Infobip
+  module SmsApi
+    class Message
+
+      attr_accessor :from, :to, :text
+
+      def initialize(attributes)
+        self.from = attributes[:from]
+        self.to = attributes[:to]
+        self.text = attributes[:text]
+      end
+
+      def to_hash
+        hash = {}
+        self.instance_variables.each do |var|
+          hash[var.to_s.delete('@')] = self.instance_variable_get(var)
+        end
+        hash
+      end
+
+      def send_text
+        response = Infobip::SmsApi.configuration.connection.post do |req|
+          req.url '/sms/1/text/single'
+          req.body = self.to_hash.to_json
+          req.headers['Accept'] = 'application/json'
+          req.headers['Content-Type'] = 'application/json'
+        end
+        Infobip::SmsApi::Response::Base.new(response.status, JSON.parse(response.body))
+      end
+
+    end
+  end
+end

data/lib/infobip/sms_api/response.rb

@@ -0,0 +1,10 @@
+require 'infobip/sms_api/response/base'
+require 'infobip/sms_api/response/message'
+require 'infobip/sms_api/response/status'
+module Infobip
+  module SmsApi
+    module Response
+
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+module Infobip
+  module SmsApi
+    module Response
+      class Base
+        SUCCESSFUL_STATUSES = %w|PENDING ACCEPTED|
+        attr_reader :messages, :status, :request_error, :data
+
+        def initialize(status, attributes)
+          @status = status
+          @data = attributes
+          case @status
+            when 200
+              @messages = []
+              attributes['messages'].each do |message|
+                @messages << Infobip::SmsApi::Response::Message.new(message)
+              end
+            when 401
+              @request_error = attributes['requestError']
+            else
+          end
+        end
+
+        ##
+        # Return true if all messages are successfully sent
+        def successful?
+          @messages && (@messages.collect(&:status).collect(&:group_name).uniq - SUCCESSFUL_STATUSES).size == 0
+        end
+
+        ##
+        # Return the list of all failed messages
+        def failed_messages
+          @messages.select { |message|
+            !SUCCESSFUL_STATUSES.include?message.status.group_name
+          }
+        end
+
+        ##
+        # Return the list of all sent messages
+        def sent_messages
+          @messages.select { |message|
+            SUCCESSFUL_STATUSES.include?message.status.group_name
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module Infobip
+  module SmsApi
+    module Response
+      class Message
+        attr_reader :to, :status, :sms_count, :message_id
+
+        def initialize(attributes)
+          @to = attributes['to']
+          @status = Infobip::SmsApi::Response::Status.new(attributes['status'])
+          @sms_count = attributes['smsCount']
+          @message_id = attributes['messageId']
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Infobip
+  module SmsApi
+    module Response
+      class Status
+        attr_reader :group_id, :group_name, :id, :name, :description
+
+        def initialize(attributes)
+          @group_id = attributes['groupId']
+          @group_name = attributes['groupName']
+          @id = attributes['id']
+          @name = attributes['name']
+          @description = attributes['description']
+        end
+      end
+    end
+  end
+end

data/lib/infobip/sms_api/version.rb

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

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: infobip-sms-api-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- dkocic
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: Rails Gem Wrapper for InfoBip SMS API.
+email:
+- kocicdamir87@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- 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/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/status.rb
+- lib/infobip/sms_api/version.rb
+homepage: https://github.com/dkocic/infobip-sms-api-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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Rails Gem Wrapper for InfoBip SMS API
+test_files: []