mprofi_api_client 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f0353b028a8b6b41a5b9fb50a66cf78e7642b60b
-  data.tar.gz: 1f272443acd95a11f83a921656182ab7beab1d1c
+SHA256:
+  metadata.gz: e672e6efb39e725b2e70c5ca5fb305da4791f6bba01f7f5a342b4b99d598c4f5
+  data.tar.gz: f990673eac1bf7e0c2f3346303d1383374d479ada6041c04b9d2806bc5846731
 SHA512:
-  metadata.gz: d464335a2a506eb682a360b088e553210305bf4904a52b78b9a4ce1464e4d2b0c29bdcf5b26779a94897d6d4799bd9e6e5322d736a61da40748f1c0cfb8aaa10
-  data.tar.gz: ff437de57ff0c4963c99c44c0ee6e0d3d2d73194ba180cfc873fb159f31c135f17da44a20875211e0ea7dea3a5b5d147ccef459a652b37a91838c9513843fecb
+  metadata.gz: d01c66ac892de2bcf5733d1a698f1f073a5b3493e9fef42a957aa5d8543f423e430731b263c485d3c0add12dbbff3ff8761f41f9d3f2fe7d9662f29694272bb9
+  data.tar.gz: 36148abd51b617bef3aab90198eaf6e247b51e6a09c7108752b7d7566023cd6b5c544fd322865804a4ad7b63fc1de7f33edd4f927469d83d3f99ad9204d60f0c

data/LICENSE

@@ -1,16 +1,16 @@
-Copyright (c) 2015, Materna Communications.
+Copyright (c) 2015, COMVERGA Sp. z o. o.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 
 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
 
-2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the 
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the
    documentation and/or other materials provided with the distribution.
 
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, 
-BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 
-SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
-INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
+BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
+SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -1,3 +1,4 @@
+[![Gem Version](https://badge.fury.io/rb/mprofi_api_client.svg)](http://badge.fury.io/rb/mprofi_api_client)
 
 # Mprofi API connector
 
@@ -13,17 +14,17 @@ gem 'mprofi_api_client'
 
 # or
 
-gem 'mprofi_api_client', :git => 'https://github.com/materna/mprofi_api_client_ruby.git'
+gem 'mprofi_api_client', :git => 'https://github.com/comverga/mprofi_api_client_ruby.git'
 
 ```
 
 ### From github.com
 
 ```bash
-git clone https://github.com/materna/mprofi_api_client_ruby.git
+git clone https://github.com/comverga/mprofi_api_client_ruby.git
 cd mprofi_api_client_ruby
 rake build
-gem install mprofi_api_client-0.1.0.gem
+gem install mprofi_api_client-0.1.1.gem
 ```
 
 # Usage
@@ -37,14 +38,19 @@ connector = MprofiApiClient::Connector.new(API_TOKEN)
 # or
 # connector = MprofiApiClient::Connector.new(API_TOKEN, 'http://your_proxy_host_address:8080/')
 begin
+    # you can change read_timeout if the default of 60 seconds is not enough
+    # connector.read_timeout = 120
     connector.add_message('501002003', 'Test message 1', 'your-msg-id-001')
-    connector.add_message('601002003', 'Test message 2', 'your-msg-id-002')
-    result = cliend.send
-    # => [{"id"=>58}, {"id"=>59}]
+    # message with Polish diacritics
+    connector.add_message('601002003', 'Test message ąćęłńóśźż', 'your-msg-id-002', encoding: 'utf-8')
+    # scheduled message
+    connector.add_message('701002003', 'Test message 3', 'your-msg-id-003', date: '2022-08-30T12:00:00+02:00')
+    result = connector.send
+    # => [{"id"=>58},{"id"=>59},{"id"=>60}]
 
     result.each do |r|
         status = connector.get_status(r['id'])
-        # => {"status"=>"delivered", "id"=>11, "reference"=>"your-msg-id-001", "ts"=>"2015-03-26T10:55:06.098Z"}
+        # => {"status"=>"delivered", "id"=>58, "reference"=>"your-msg-id-001", "ts"=>"2015-03-26T10:55:06.098Z"}
 
         # do sth with status
     end
@@ -59,4 +65,4 @@ end
 
 ## Copyright
 
-Copyright (c) 2015 Materna Communications. See LICENSE for details.
+Copyright (c) 2015 COMVERGA Sp. z o. o. See LICENSE for details.

data/lib/mprofi_api_client/connector.rb

@@ -27,18 +27,24 @@ module MprofiApiClient
       @proxy_url = proxy_url
       @messages = []
       @clear_messages = true
+      @read_timeout = nil
     end
 
     # Add one message to message queue.
     # +recipient+:: Message recipient as string (phone number format: XXXXXXXXX f.e. 664400100).
     # +message+:: Message content as string.
     # +reference+:: Client message ID defined by user for message tracking. (optional)
-    def add_message(recipient, message, reference = nil)
+    # +options+:: Message options: encoding (default: {}):
+    #             +:encoding+ - set to 'utf-8' if you need special characters (diacritical marks, emoji),
+    #             +:date+ - time the message will be sent (accepted formats: ISO-8601, unix epoch)
+    def add_message(recipient, message, reference = nil, options = {})
       raise ArgumentError, "`recipient` cannot be empty" if recipient.nil? || recipient.empty?
       raise ArgumentError, "`message` cannot be empty" if message.nil? || message.empty?
 
       message = { 'recipient' =>  recipient, 'message' => message }
       message['reference'] = reference if reference
+      message['encoding'] = options[:encoding] if options.key?(:encoding)
+      message['date'] = options[:date] if options.key?(:date)
 
       @messages << message
     end
@@ -80,6 +86,11 @@ module MprofiApiClient
       return result
     end
 
+    # Set read timeout
+    # +timeout+ - number of seconds
+    def read_timeout=(timeout)
+      @read_timeout = timeout
+    end
 
     private
 
@@ -118,6 +129,8 @@ module MprofiApiClient
           http.verify_mode = OpenSSL::SSL::VERIFY_NONE
         end
 
+        http.read_timeout = @read_timeout unless @read_timeout.nil?
+
         result = http.request(request)
       rescue Exception => err
         raise MprofiConnectionError.new(err.message, err)

data/lib/mprofi_api_client.rb

@@ -3,6 +3,6 @@ require 'mprofi_api_client/connector'
 
 module MprofiApiClient
 
-  VERSION = '0.1.0' #:nodoc:
+  VERSION = '0.1.2' #:nodoc:
 
 end

data/mprofi_api_client.gemspec

@@ -8,10 +8,10 @@ Gem::Specification.new do |spec|
 
   spec.summary      = 'MProfi API client library'
   spec.date         = '2015-03-05'
-  spec.authors      = ['Materna Communications']
-  
-  spec.email        = 'biuro@materna.com.pl'
-  spec.homepage     = 'https://github.com/materna/mprofi_api_client-ruby'
+  spec.authors      = ['COMVERGA Sp. z o. o.']
+
+  spec.email        = 'pomoc@mprofi.pl'
+  spec.homepage     = 'https://github.com/comverga/mprofi_api_client_ruby'
   spec.description  = spec.summary
   spec.license      = 'BSD'
 

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification
 name: mprofi_api_client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
-- Materna Communications
+- COMVERGA Sp. z o. o.
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: MProfi API client library
-email: biuro@materna.com.pl
+email: pomoc@mprofi.pl
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -94,7 +94,7 @@ files:
 - lib/mprofi_api_client/connector.rb
 - lib/mprofi_api_client/connector_exception.rb
 - mprofi_api_client.gemspec
-homepage: https://github.com/materna/mprofi_api_client-ruby
+homepage: https://github.com/comverga/mprofi_api_client_ruby
 licenses:
 - BSD
 metadata: {}
@@ -113,8 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: MProfi API client library