mprofi_api_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f0353b028a8b6b41a5b9fb50a66cf78e7642b60b
+  data.tar.gz: 1f272443acd95a11f83a921656182ab7beab1d1c
+SHA512:
+  metadata.gz: d464335a2a506eb682a360b088e553210305bf4904a52b78b9a4ce1464e4d2b0c29bdcf5b26779a94897d6d4799bd9e6e5322d736a61da40748f1c0cfb8aaa10
+  data.tar.gz: ff437de57ff0c4963c99c44c0ee6e0d3d2d73194ba180cfc873fb159f31c135f17da44a20875211e0ea7dea3a5b5d147ccef459a652b37a91838c9513843fecb

data/Gemfile

@@ -0,0 +1,7 @@
+source 'http://rubygems.org'
+
+group :test do    
+    gem 'minitest', '~> 5.5.1'
+    gem 'minitest-reporters'
+    gem 'webmock', '~> 1.20.4'
+end

data/LICENSE

@@ -0,0 +1,16 @@
+Copyright (c) 2015, Materna Communications.
+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 
+   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 
+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

@@ -0,0 +1,62 @@
+
+# Mprofi API connector
+
+This is a mProfi library for Ruby, supportig the mProfi.pl HTTP API.
+
+
+## Installation
+
+### In Bundler:
+
+```ruby
+gem 'mprofi_api_client'
+
+# or
+
+gem 'mprofi_api_client', :git => 'https://github.com/materna/mprofi_api_client_ruby.git'
+
+```
+
+### From github.com
+
+```bash
+git clone https://github.com/materna/mprofi_api_client_ruby.git
+cd mprofi_api_client_ruby
+rake build
+gem install mprofi_api_client-0.1.0.gem
+```
+
+# Usage
+
+```ruby
+require 'mprofi_api_client'
+
+API_TOKEN = 'token from mprofi.pl website'
+
+connector = MprofiApiClient::Connector.new(API_TOKEN)
+# or
+# connector = MprofiApiClient::Connector.new(API_TOKEN, 'http://your_proxy_host_address:8080/')
+begin
+    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}]
+
+    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"}
+
+        # do sth with status
+    end
+
+rescue MprofiAuthError
+    # invalid token
+rescue MprofiConnectionError
+    # communication error
+end
+
+```
+
+## Copyright
+
+Copyright (c) 2015 Materna Communications. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rdoc/task'
+
+GEMSPEC_FILE = 'mprofi_api_client.gemspec'
+
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/test*.rb']
+  #t.verbose = true
+end
+
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.main = 'README.md'
+  rdoc.rdoc_files.include("README.md", "lib/**/*.rb", "LICENSE")
+end
+
+desc 'Build gem'
+task :build do
+  sh "bundle exec gem build #{GEMSPEC_FILE}"
+end

data/lib/mprofi_api_client.rb

@@ -0,0 +1,8 @@
+
+require 'mprofi_api_client/connector'
+
+module MprofiApiClient
+
+  VERSION = '0.1.0' #:nodoc:
+
+end

data/lib/mprofi_api_client/connector.rb

@@ -0,0 +1,135 @@
+require 'net/https'
+require 'json'
+require 'mprofi_api_client/connector_exception'
+
+# Module with connector managing communication with mProfi API.
+module MprofiApiClient
+
+  API_BASE_URL = 'https://api.mprofi.pl' #:nodoc:
+  API_VERSION = '1.0' #:nodoc:
+
+  class MprofiConnectionError < ConnectorException ; end
+  class MprofiAuthError < ConnectorException ; end
+  class MprofiNotFoundError < ConnectorException ; end
+
+  # Connector class that manages communication with mProfi public API.
+  class Connector
+
+    attr_reader :messages
+    attr_accessor :clear_messages #:nodoc:
+
+    # +api_token+:: api token, as string. If api_token is not specified `MPROFI_API_TOKEN` env variable will be used.
+    # +proxy_url+:: proxy URL (optional)
+    def initialize(api_token = nil, proxy_url = nil)
+      @api_token = api_token || ENV['MPROFI_API_TOKEN']
+      raise ArgumentError, "API token not defined!" unless @api_token
+
+      @proxy_url = proxy_url
+      @messages = []
+      @clear_messages = true
+    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)
+      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
+
+      @messages << message
+    end
+
+    # Send messages stored in message queue.
+    # +raises+:: _MprofiAuthError_, _MprofiNotFoundError_, _MprofiConnectionError_
+    def send
+      raise StandardError, 'Empty payload. Please use `add_message` first.' unless @messages.size > 0
+
+      if send_bulk?
+        operation = 'sendbulk'
+        payload = { 'messages' => @messages }
+      else
+        operation = 'send'
+        payload = @messages.first
+      end
+
+      request = create_request(operation, :post, payload.to_json)
+      result = send_request(request)
+      @messages.clear if @clear_messages
+
+      if result.has_key?('result')
+        return result['result']
+      else
+        return [result]
+      end
+    end
+
+    # Check status of message with given id
+    # +msg_id+:: message id
+    #
+    # +raises+:: _MprofiNotFound_ - if message id not found
+    def get_status(msg_id)
+      raise ArgumentError, '`msg_id` cannot be nil' if msg_id.nil?
+
+      request = create_request('status', :get, "id=#{msg_id}")
+      result = send_request(request)
+
+      return result
+    end
+
+
+    private
+
+    def send_bulk? #:nodoc:
+      @messages.size > 1
+    end
+
+    def create_request(operation, req_method = :get, body_or_query_string = nil) #:nodoc:
+      uri = URI.parse([API_BASE_URL, API_VERSION, operation, ''].join('/'))
+
+      case req_method
+      when :post
+        request = Net::HTTP::Post.new(uri)
+        request.content_type = 'application/json'
+        request.body = body_or_query_string
+      when :get
+        uri.query = body_or_query_string
+        request = Net::HTTP::Get.new(uri)
+      else
+        raise ArgumentError, 'Method not supported'
+      end
+
+      request['Authorization'] = "Token #{@api_token}"
+
+      return request
+    end
+
+    def send_request(request) #:nodoc:
+      uri = request.uri
+      begin
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.proxy_address = @proxy_url if @proxy_url
+
+        if uri.scheme == 'https'
+          http.use_ssl = true
+          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        end
+
+        result = http.request(request)
+      rescue Exception => err
+        raise MprofiConnectionError.new(err.message, err)
+      end
+
+      raise MprofiAuthError, 'Invalid API token' if result.is_a?(Net::HTTPUnauthorized)
+      raise MprofiNotFoundError, 'Not found' if result.is_a?(Net::HTTPNotFound)
+      raise MprofiConnectionError, "HTTP code: #{result.code}, result: #{result.body}" unless result.is_a?(Net::HTTPSuccess)
+
+      return JSON.parse(result.body)
+    end
+
+  end
+
+end

data/lib/mprofi_api_client/connector_exception.rb

@@ -0,0 +1,13 @@
+
+module MprofiApiClient
+
+  class ConnectorException < StandardError
+    attr_reader :original
+
+    def initialize(msg, original = nil)
+      super(msg)
+      @original = original
+    end
+  end
+
+end

data/mprofi_api_client.gemspec

@@ -0,0 +1,30 @@
+$LOAD_PATH.unshift(File.expand_path('../lib', __FILE__))
+
+require 'mprofi_api_client'
+
+Gem::Specification.new do |spec|
+  spec.name 				= 'mprofi_api_client'
+  spec.version      = MprofiApiClient::VERSION
+
+  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.description  = spec.summary
+  spec.license      = 'BSD'
+
+  spec.required_ruby_version = '>= 1.9.3'
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'minitest-reporters'
+  spec.add_development_dependency 'webmock'
+
+
+  spec.files        = %w(Gemfile LICENSE mprofi_api_client.gemspec Rakefile README.md)
+  spec.files        += Dir.glob('lib/**/*.rb')
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: mprofi_api_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Materna Communications
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: minitest
+  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: minitest-reporters
+  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: webmock
+  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'
+description: MProfi API client library
+email: biuro@materna.com.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/mprofi_api_client.rb
+- 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
+licenses:
+- BSD
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: MProfi API client library
+test_files: []