comtele_sdk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 422a4f7bfe76680b325265cb42123f2872187069c5008ca8be1bbc3d5177ae4d
+  data.tar.gz: 5b34604d6bb5126bc5e0a53f3bfea165a787013804c194754355b7c46b24af8e
+SHA512:
+  metadata.gz: 132ab0f9510a584e7e79729ab1836c47bcd985a048eb7666239eb546ce7eee1bd0ce69cd6e86bcd9b0ba898e3ba8bfb150299aa8537766de157d1ae2bc725ea6
+  data.tar.gz: caccde6da7aa568dc80d5ba33aa890d660e74ecc3a12e5d63cd7c23c1f0a92038810619071d1619923a16a2d433fe5c9c182219ff51eefb403840227f9075aed

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in comtele_sdk.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Diego Vieira
+
+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,39 @@
+# ComteleSdk
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/comtele_sdk`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'comtele_sdk'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install comtele_sdk
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/[USERNAME]/comtele_sdk.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://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 "comtele_sdk"
+
+# 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(__FILE__)

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/comtele_sdk.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "comtele_sdk/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "comtele_sdk"
+  spec.version       = ComteleSdk::VERSION
+  spec.authors       = ["Diego Vieira"]
+  spec.email         = ["desenvolvimento@comtele.com.br"]
+
+  spec.summary       = %q{SDK para envio de mensagens de texto usando a plataforma Comtele (Ruby)}
+  spec.homepage      = "https://docs.comtele.com.br"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rest-client"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/comtele_sdk/version.rb

@@ -0,0 +1,3 @@
+module ComteleSdk
+  VERSION = "1.0.0"
+end

data/lib/comtele_sdk.rb

@@ -0,0 +1,205 @@
+require "comtele_sdk/version"
+require 'rest-client'
+require 'json'
+
+module ComteleSdk
+    class AccountService 
+
+        def initialize(api_key)
+            @api_key = api_key
+            @base_address = 'https://sms.comtele.com.br/api/v2' 
+            @headers = {
+                'Accept': 'application/json',
+                'Content-type': 'application/json',            
+                'auth-key': @api_key
+            }   
+        end    
+    
+        def get_account_by_username(username)    
+            url = @base_address + '/accounts/' + username
+            response = RestClient.get(url, @headers)
+            
+            return JSON.parse(response)
+        end
+    
+        def get_all_accounts
+            url = @base_address + '/accounts'
+            response = RestClient.get(url, @headers)
+            
+            return JSON.parse(response)
+        end
+    end
+
+    class ContextMessageService
+        def initialize(api_key)
+            @api_key = api_key
+            @base_address = 'https://sms.comtele.com.br/api/v2' 
+            @headers = {
+                'Accept': 'application/json',
+                'Content-type': 'application/json',            
+                'auth-key': @api_key
+            }  
+        end
+    
+        def send(sender, context_rule_name, receivers)
+            url = @base_address + '/sendcontextmessage'   
+            
+            payload = JSON.generate({
+                'sender': sender,
+                'contextRuleName': context_rule_name,
+                'receivers': receivers.join(',')
+            })
+    
+            response = RestClient.post(url, payload, @headers)
+    
+            return JSON.parse(response)
+        end 
+    
+        def schedule(sender, context_rule_name, schedule_date, receivers)
+            url = @base_address + '/schedulecontextmessage'   
+            
+            payload = JSON.generate({
+                'sender': sender,
+                'contextRuleName': context_rule_name,
+                'scheduleDate': schedule_date,
+                'receivers': receivers.join(',')
+            })
+    
+            response = RestClient.post(url, payload, @headers)
+    
+            return JSON.parse(response)
+        end 
+    
+        def get_report(start_date, end_date, sender = '', context_rule_name = '')
+            url = @base_address + '/contextreporting?startDate=' + start_date + '&endDate=' + end_date + '&sender=' + sender + '&contextRuleName=' + context_rule_name
+            response = RestClient.get(url, @headers)
+            
+            return JSON.parse(response)
+        end 
+    end
+
+    class CreditService
+        def initialize(api_key)
+            @api_key = api_key
+            @base_address = 'https://sms.comtele.com.br/api/v2' 
+            @headers = {
+                'Accept': 'application/json',
+                'Content-Type': 'application/json',            
+                'auth-key': @api_key
+            }
+        end
+    
+        def get_credits(username)
+            url = @base_address + '/credits/' + username
+            response = RestClient.get(url, @headers)
+    
+            return JSON.parse(response)
+        end 
+    
+        def get_my_credits
+            url = @base_address + '/credits'
+            response = RestClient.get(url, @headers)
+    
+            return JSON.parse(response)
+        end 
+    
+        def get_history(username)
+            url = @base_address + '/balancehistory/' + username
+            response = RestClient.get(url, @headers)
+    
+            return JSON.parse(response)
+        end 
+    
+        def add_credits(username, amount)
+            url = @base_address + '/credits/'+ username + '?amount=' + amount.to_s        
+            response = RestClient.put(url, {}, @headers)
+    
+            return JSON.parse(response)
+        end 
+    end
+
+    class DeliveryStatus
+        ALL = 'all'
+        DELIVERED = 'true'
+        UNDELIVERED = 'false'
+    end
+
+    class ReplyService
+        def initialize(api_key)
+            @api_key = api_key
+            @base_address = 'https://sms.comtele.com.br/api/v2' 
+            @headers = {
+                'Accept': 'application/json',
+                'Content-type': 'application/json',            
+                'auth-key': @api_key
+            }  
+        end
+    
+        def get_report(start_date, end_date, sender = '')
+            url = @base_address + '/replyreporting?startDate=' + start_date + '&endDate=' + end_date + '&sender=' + sender 
+            response = RestClient.get(url, @headers)
+            
+            return JSON.parse(response)
+        end 
+    end
+
+    class ReportGroupType
+        MONTHLY = 'true'
+        DAILY = 'false'
+    end 
+
+    class TextMessageService
+        def initialize(api_key)
+            @api_key = api_key
+            @base_address = 'https://sms.comtele.com.br/api/v2' 
+            @headers = {
+                'Accept': 'application/json',
+                'Content-type': 'application/json',            
+                'auth-key': @api_key
+            }   
+        end
+    
+        def send(sender, content, receivers)
+            url = @base_address + '/send'   
+            
+            payload = JSON.generate({
+                'sender': sender,
+                'content': content,
+                'receivers': receivers.join(',')
+            })
+    
+            response = RestClient.post(url, payload, @headers)
+    
+            return JSON.parse(response)
+        end 
+    
+        def schedule(sender, content, schedule_date, receivers)
+            url = @base_address + '/schedule'
+            
+            payload =  JSON.generate({
+                'sender': sender,
+                'content': content,
+                'scheduleDate': schedule_date,
+                'receivers': receivers.join(',')
+            })
+    
+            response = RestClient.post(url, payload, @headers)
+    
+            return JSON.parse(response)
+        end 
+    
+        def get_detailed_report(start_date, end_date, delivery_status)
+            url = @base_address + '/detailedreporting?startDate=' + start_date + '&endDate=' + end_date + '&delivered=' + delivery_status
+            response = RestClient.get(url, @headers)
+            
+            return JSON.parse(response)
+        end
+    
+        def get_consolidated_report(start_date, end_date, group_type)
+            url = @base_address + '/consolidatedreporting?startDate=' + start_date + '&endDate=' + end_date + '&group=' + group_type
+            response = RestClient.get(url, @headers)
+            
+            return JSON.parse(response)    
+        end 
+    end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: comtele_sdk
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Diego Vieira
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: 
+email:
+- desenvolvimento@comtele.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- comtele_sdk.gemspec
+- lib/comtele_sdk.rb
+- lib/comtele_sdk/version.rb
+homepage: https://docs.comtele.com.br
+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.7.6
+signing_key: 
+specification_version: 4
+summary: SDK para envio de mensagens de texto usando a plataforma Comtele (Ruby)
+test_files: []