smsapi-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aa2a44ea645440e177899b0a1de97bffe64d5e35
+  data.tar.gz: 1752a0ee074d508585c26b132fdd143d37ed2772
+SHA512:
+  metadata.gz: 64c1c2dfc5e8a4b071b5a9c1abb1463d9a472c09da0ce74d98e28a39178ce6d0bac740923b11e2b00c8dcd0ce41fb5972844bc400dc1351d211929cc4f495eba
+  data.tar.gz: 629bbc32ed73c0b32164b8b6859f9ac6816a481ef9eedd8119c3cef9392035b212d47288794dd9cc904ecd34d1749f91dc94ab1e9891af7525cc34d518ffb9ea

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in smsapi-client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Michal Musialik
+
+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,69 @@
+# SMSApi::Client
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'smsapi-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install smsapi-client
+
+## Usage
+
+```ruby
+# Create the client
+client = SMSApi::Client.new('username', 'password')
+
+# Send a single text message
+sms = client.send_single 500500500, 'Text Message'
+sms.status   # 'OK'
+sms.success? # => true
+sms.points   # => 0.12
+
+# When something goes wrong
+sms.status        # 'ERROR'
+sms.success?      # => false
+sms.error?        # => true
+sms.error_code    # => 101
+sms.error_message # => 'Bad Credentials'
+
+# Any additional options can be passed as last argument
+sms = client.send_single 500500500, 'Text Message', test: '1'
+
+# Schedule a single message to be sent in the future
+when = DateTime.new(2015, 10, 10)
+sms = client.schedule_single 500500500, 'Text Message', when
+
+# Sending messages in bulk
+bulk = client.send_bulk [500500500, 600600600, 7007007], 'Text Message', test: '1'
+
+# Gives access to an array of sent messages
+bulk.sent
+bulk.sent.first.success? # => true
+
+# The api returns only statuses for successful messages. Since one of our
+# numbers was too short the array contains only 2 items.
+bulk.sent.count # => 2
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/smsapi-client/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/console

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

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/smsapi/bulk_sms.rb

@@ -0,0 +1,36 @@
+module SMSApi
+  class BulkSMS
+    include SMSApi::Defaults
+
+    attr_reader :sent, :to, :message
+    def initialize(to, message, server, options = {})
+      @options = default_options.merge options
+      @to = to
+      @message = message
+      @server = server
+      @sent = []
+    end
+
+    def deliver
+      read_response @server.sms(server_params)
+      self
+    end
+
+    private
+
+    def server_params
+      @options.merge(
+        to: to.join(','),
+        message: message
+      )
+    end
+
+    def read_response(response)
+      response.each do |single_response|
+        sms = SMS.new(single_response.split(':').last, message, @server, @options)
+        sms.read_response(single_response)
+        @sent << sms
+      end
+    end
+  end
+end

data/lib/smsapi/client.rb

@@ -0,0 +1,23 @@
+module SMSApi
+  class Client
+    def initialize(username, password)
+      @server = Server.new(username, password)
+    end
+
+    def send_single(to, message, options = {})
+      SMS.new(to, message, @server, options).deliver
+    end
+
+    def schedule_single(to, message, date, options = {})
+      SMS.new(to, message, @server, options).deliver_at(date)
+    end
+
+    def send_bulk(to, message, options = {})
+      BulkSMS.new(to, message, @server, options).deliver
+    end
+
+    def details
+      # not implemented
+    end
+  end
+end

data/lib/smsapi/defaults.rb

@@ -0,0 +1,8 @@
+module SMSApi::Defaults
+  def default_options
+    {
+      from: 'eco',
+      test: '1'
+    }
+  end
+end

data/lib/smsapi/group_sms.rb

@@ -0,0 +1,7 @@
+module SMSApi
+  class GroupSms < BulkSMS
+    def send
+      # read_response = server.send_group(server_params)
+    end
+  end
+end

data/lib/smsapi/server.rb

@@ -0,0 +1,33 @@
+module SMSApi
+  class Server
+    def initialize(username, password)
+      @username = username
+      @password = password
+      @connection = setup_connection
+    end
+
+    def sms(params = {})
+      api_response = make_request(SMSApi::API[:sms_path], params)
+      api_response.split(';')
+    end
+
+    private
+
+    def setup_connection
+      SMSApi::Server::Connection.new(
+        SMSApi::API[:uri],
+        SMSApi::API[:port]
+      )
+    end
+
+    def make_request(path, params)
+      params = authorize_params(params)
+      response = @connection.post(path, params)
+      response.body
+    end
+
+    def authorize_params(params)
+      params.merge(username: @username, password: @password)
+    end
+  end
+end

data/lib/smsapi/server/connection.rb

@@ -0,0 +1,25 @@
+require 'net/http'
+
+module SMSApi
+  class Server
+    class Connection
+      def initialize(uri, port)
+        @http = Net::HTTP.new(uri, port)
+        @http.use_ssl = true
+        @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+
+      def post(path, params)
+        @http.request post_request(path, params)
+      end
+
+      private
+
+      def post_request(path, params)
+        request = Net::HTTP::Post.new(path)
+        request.set_form_data(params)
+        request
+      end
+    end
+  end
+end

data/lib/smsapi/sms.rb

@@ -0,0 +1,63 @@
+module SMSApi
+  class SMS
+    include SMSApi::Defaults
+
+    attr_accessor :to, :message, :id, :points, :status, :error_code, :date
+    def initialize(to, message, server, options = {})
+      @options = default_options.merge options
+      @to = to
+      @message = message
+      @server = server
+    end
+
+    def deliver
+      read_response @server.sms(server_params).first
+      self
+    end
+
+    def deliver_at(date)
+      @date = date
+      params = server_params.merge(date: date.to_time.to_i)
+
+      read_response @server.sms(params).first
+      self
+    end
+
+    def sent?
+      not self.status.nil?
+    end
+
+    def error?
+      self.status == 'ERROR'
+    end
+
+    def success?
+      self.status == 'SUCCESS'
+    end
+
+    def error_message
+      SMSApi::ERROR_MESSAGES[error_code]
+    end
+
+    def read_response(response)
+      response = response.split(':')
+
+      self.status = response[0]
+      if status == 'ERROR'
+        self.error_code = response[1]
+      else
+        self.id = response[1]
+        self.points = response[2]
+      end
+    end
+
+    private
+
+    def server_params
+      @options.merge(
+        to: to,
+        message: message
+      )
+    end
+  end
+end

data/lib/smsapi/smsapi.rb

@@ -0,0 +1,23 @@
+require 'smsapi/server'
+require 'smsapi/server/connection'
+require 'smsapi/client'
+require 'smsapi/defaults'
+require 'smsapi/sms'
+require 'smsapi/bulk_sms'
+require 'smsapi/group_sms'
+
+module SMSApi
+  class Error < StandardError; end
+  class ServerError < Error; end
+
+  VERSION = "0.1.0"
+  API = {
+    uri: 'ssl.smsapi.pl',
+    port: 443,
+    sms_path: '/sms.do'
+  }
+
+  ERROR_MESSAGES = {
+    '101' => 'Bad Credentials',
+  }
+end

data/smsapi-client.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'smsapi/smsapi'
+
+Gem::Specification.new do |spec|
+  spec.name          = "smsapi-client"
+  spec.version       = SMSApi::VERSION
+  spec.authors       = ["Alek Niemczyk", "Marek Machula", "Marcin Drozd", "Michal Musialik"]
+  spec.email         = ["info@rubylogic.pl"]
+
+  spec.summary       = 'SMSAPI.pl Ruby client'
+  spec.description   = 'SMSAPI.pl Ruby client'
+  spec.homepage      = 'https://github.com/rubylogicgems/smsapi-client'
+  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.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: smsapi-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alek Niemczyk
+- Marek Machula
+- Marcin Drozd
+- Michal Musialik
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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'
+description: SMSAPI.pl Ruby client
+email:
+- info@rubylogic.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/smsapi/bulk_sms.rb
+- lib/smsapi/client.rb
+- lib/smsapi/defaults.rb
+- lib/smsapi/group_sms.rb
+- lib/smsapi/server.rb
+- lib/smsapi/server/connection.rb
+- lib/smsapi/sms.rb
+- lib/smsapi/smsapi.rb
+- smsapi-client.gemspec
+homepage: https://github.com/rubylogicgems/smsapi-client
+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: SMSAPI.pl Ruby client
+test_files: []