primotexto 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f253be2828781bb54cbe4afb000a630a0c66251a
+  data.tar.gz: e3af78a14752af77c3c7d60e153a2eec83c3b476
+SHA512:
+  metadata.gz: bc4fbfc056f9399cd3cb63b3be25a7e6eb8d2616783945d94b6b59d96e412ecae4feac6b45476dbd0ceb564af5926ad71dcaa4d8b9a00229a9ade751a2d266b1
+  data.tar.gz: c67ca0dedc222fd732d00803f04f54fe9ae70806438ff71dd544898997c7c5d5fb4f53461c05365b9c637392a11ffa83e6b407b8ff46142a4e631f76d5b4ea8b

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,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 syntaxTerr0r
+
+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,168 @@
+# Primotexto
+
+This is an unofficial Ruby client for the [Primotexto API](https://www.primotexto.com/api/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'primotexto'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install primotexto
+
+## Usage
+
+All API methods are not implemented yet. Here is an exhaustive list of what is currently supported.
+
+### Initializing a new client
+
+```ruby
+pt = Primotexto.client(key: 'MY_SHINY_API_KEY')
+```
+
+Alternatively, you can define the key in the `PRIMOTEXTO_API_KEY` `ENV` variable:
+
+```ruby
+pt = Primotexto.client
+```
+
+### Sending SMS notification message
+
+[API reference](https://www.primotexto.com/api/messages/send-notification.asp)
+
+```ruby
+message = pt.post_notification_message(number: '+33612345678', sender: 'Spiderman', message: 'Your new code is "W0WE".', category: 'codeConfirmation')
+```
+
+### Sending SMS marketing message
+
+[API reference](https://www.primotexto.com/api/messages/send-marketing.asp)
+
+```ruby
+message = pt.post_marketing_message(number: '+33612345678', sender: 'Carwash', message: 'Get 30% off with this coupon: "W4SH" until tomorrow.')
+```
+
+See more about [E.164](https://en.wikipedia.org/wiki/E.164) phone formatting.
+
+### Getting a message's status
+
+[API reference](https://www.primotexto.com/api/messages/status.asp)
+
+By phone number
+
+```ruby
+pt.get_messages_status(identifier: '+33612345678')
+```
+
+Or by snapshotId
+
+```ruby
+pt.get_messages_status(snapshotId: message[:snapshotId])
+```
+
+### Getting messages' stats
+
+[API reference](https://www.primotexto.com/api/messages/stats.asp)
+
+```ruby
+pt.get_messages_stats(category: 'codeConfirmation')
+```
+
+### Getting a messages' replies
+
+[API reference](https://www.primotexto.com/api/messages/callbacks.asp)
+
+```ruby
+pt.get_messages_replies(category: 'codeConfirmation')
+```
+
+### Getting messages' blacklists (Bounces + Unsubscribers)
+
+[API reference](https://www.primotexto.com/api/account/stats.asp)
+
+```ruby
+pt.get_messages_blacklists(category: 'codeConfirmation')
+```
+
+### Unsubscribers
+
+[API reference](https://www.primotexto.com/api/account/unsubscribers.asp)
+
+#### Getting unsubscribers list
+
+```ruby
+pt.get_unsubscribers_contacts
+```
+
+#### Adding a phone number to unsubscribers list
+
+```ruby
+pt.post_unsubscribers_contacts(identifier: '+33612345678')
+```
+
+##### Removing a phone number from unsubscribers list
+
+[API reference](https://www.primotexto.com/api/account/stats.asp)
+
+```ruby
+pt.delete_unsubscribers_contacts(identifier: '+33612345678')
+```
+
+### Bounces
+
+[API reference](https://www.primotexto.com/api/account/bounces.asp)
+
+#### Getting bounces list
+
+```ruby
+pt.get_bounces_contacts
+```
+
+#### Adding a phone number to bounces list
+
+```ruby
+pt.post_bounces_contacts(identifier: '+33612345678')
+```
+
+##### Removing a phone number from bounces list
+
+[API reference](https://www.primotexto.com/api/account/stats.asp)
+
+```ruby
+pt.delete_bounces_contacts(identifier: '+33612345678')
+```
+
+### Getting you account stats
+
+[API reference](https://www.primotexto.com/api/account/stats.asp)
+
+```ruby
+pt.get_account_stats
+```
+
+## Testing
+
+This gem has no specs yet.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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/syntaxTerr0r/primotexto.
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "primotexto"
+
+# 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/lib/primotexto/client/constants.rb

@@ -0,0 +1,52 @@
+module Primotexto
+  class Client
+    ERROR_CODES = {
+      10 => 'no phone number provided',
+      11 => 'invalid phone number syntax',
+      12 => 'number blacklisted unsubscribed',
+      13 => 'number blacklisted user bounce',
+      14 => 'number blacklisted global bounce',
+      15 => 'number already exists',
+      20 => 'invalid characters in sender',
+      21 => 'sender too short',
+      22 => 'sender too long',
+      23 => 'full numeric sender not allowed',
+      30 => 'no message content provided',
+      31 => 'invalid characters in message',
+      32 => 'message content too long',
+      40 => 'invalid campaign name',
+      41 => 'invalid campaign programming time',
+      42 => 'campaign cannot be deleted',
+      43 => 'campaign cannot be cancelled',
+      44 => 'free mode campaign limit reached',
+      45 => 'invalid campaign tag',
+      46 => 'tag already exists',
+      47 => 'campaign not found',
+      48 => 'invalid campaign send list',
+      60 => 'list not found',
+      61 => 'invalid date format',
+      70 => 'api access disabled',
+      71 => 'insufficient credits',
+      72 => 'authentication failed',
+      91 => 'international mode needed'
+    }.freeze
+
+    API_HOST = 'api.primotexto.com'.freeze
+
+    API_METHODS_MAP = [
+      ['post_notification_message', 'post_notification_messages_send_params'],
+      ['post_marketing_message', 'post_marketing_messages_send_params'],
+      'get_messages_status_params',
+      'get_account_stats',
+      'get_messages_stats_params',
+      'get_messages_replies_params',
+      'get_messages_blacklists_params',
+      ['get_bounces_contacts', 'get_bounces_default_contacts'],
+      ['post_bounces_contacts', 'post_bounces_default_contacts_params'],
+      ['delete_bounces_contacts', 'delete_bounces_default_contacts_params'],
+      ['get_unsubscribers_contacts', 'get_unsubscribers_default_contacts'],
+      ['post_unsubscribers_contacts', 'post_unsubscribers_default_contacts_params'],
+      ['delete_unsubscribers_contacts', 'delete_unsubscribers_default_contacts_params'],
+    ].freeze
+  end
+end

data/lib/primotexto/client/http.rb

@@ -0,0 +1,70 @@
+require 'net/http'
+require 'json'
+require 'cgi'
+
+module Primotexto
+  class Client
+    private
+
+    def get(path, params = {})
+      uri = full_url_with(path)
+      uri.query = query_string(params)
+      get_request = Net::HTTP::Get.new(uri.request_uri)
+      get_request['X-Primotexto-ApiKey'] = @key
+      get_request['Content-Type'] = 'application/json'
+      parse query(uri.host, get_request)
+    end
+
+    def post(path, params)
+      uri = full_url_with(path)
+      post_request = Net::HTTP::Post.new(uri.request_uri)
+      post_request['X-Primotexto-ApiKey'] = @key
+      post_request['Content-Type'] = 'application/json'
+      post_request.body = params.to_json
+      parse query(uri.host, post_request)
+    end
+
+    def delete(path, params)
+      uri = full_url_with(path)
+      uri.query = query_string(params)
+      delete_request = Net::HTTP::Delete.new(uri.request_uri)
+      delete_request['X-Primotexto-ApiKey'] = @key
+      delete_request['Content-Type'] = 'application/json'
+      parse query(uri.host, delete_request)
+    end
+
+    def query(host, http_request)
+      http = Net::HTTP.new(host, Net::HTTP.https_default_port)
+      http.use_ssl = true
+      http.request(http_request)
+    end
+
+    def full_url_with(path)
+      URI.join("https://#{API_HOST}", "/v2#{path}")
+    end
+
+    def parse(http_response)
+      case http_response
+      when Net::HTTPSuccess
+        if http_response['Content-Type'].split(';').first == 'application/json'
+          JSON.parse!(http_response.body, symbolize_names: true)
+        else
+          http_response.body
+        end
+      when Net::HTTPUnauthorized
+        raise AuthenticationError
+      else
+        error_code = JSON.parse(http_response.body)['code']
+        raise Error, "#{ERROR_CODES[error_code]} (code: #{error_code})"
+      end
+    end
+
+    def query_string(params)
+      params.flat_map { |k, vs| Array(vs).map { |v| "#{escape(k)}=#{escape(v)}" } }.join('&')
+    end
+
+    def escape(component)
+      CGI.escape(component.to_s)
+    end
+  end
+end

data/lib/primotexto/client.rb

@@ -0,0 +1,34 @@
+require "primotexto/client/constants"
+require "primotexto/client/http"
+
+module Primotexto
+  class Client
+    attr_reader :key
+
+    def initialize(options = {})
+      @key = options.fetch(:key) { ENV.fetch('PRIMOTEXTO_API_KEY') }
+    end
+
+    API_METHODS_MAP.each do |api_method|
+      if api_method.is_a?(Array)
+        friendly_method = api_method.first
+        api_method = api_method.last
+      end
+
+      method = api_method.split('_')
+      with_params = api_method.include?('params')
+      method.pop if with_params
+      friendly_method = method.join('_') if friendly_method.nil?
+      verb = method.shift
+      uri = '/'
+      uri += method.join('/')
+
+      if with_params
+        behaviour = -> (params) { send(verb, uri, params) }
+      else
+        behaviour = -> { send(verb, uri) }
+      end
+      define_method(friendly_method.to_sym, &behaviour)
+    end
+  end
+end

data/lib/primotexto/version.rb

@@ -0,0 +1,3 @@
+module Primotexto
+  VERSION = "0.1.0"
+end

data/lib/primotexto.rb

@@ -0,0 +1,11 @@
+require "primotexto/client"
+require "primotexto/version"
+
+module Primotexto
+  def self.client(options = {})
+    Client.new(options)
+  end
+
+  class Error < StandardError; end
+  class AuthenticationError < Error; end
+end

data/primotexto.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'primotexto/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "primotexto"
+  spec.version       = Primotexto::VERSION
+  spec.authors       = ["Sébastien Poudat"]
+  spec.email         = ["synthax.terror@gmail.com"]
+
+  spec.summary       = %q{Ruby client for the Primotexto API}
+  spec.description   = %q{Send SMS easily}
+  spec.homepage      = "https://github.com/syntaxTerr0r/primotexto"
+  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 "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: primotexto
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sébastien Poudat
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-22 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: rspec
+  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'
+description: Send SMS easily
+email:
+- synthax.terror@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/primotexto.rb
+- lib/primotexto/client.rb
+- lib/primotexto/client/constants.rb
+- lib/primotexto/client/http.rb
+- lib/primotexto/version.rb
+- primotexto.gemspec
+homepage: https://github.com/syntaxTerr0r/primotexto
+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.5
+signing_key: 
+specification_version: 4
+summary: Ruby client for the Primotexto API
+test_files: []
+has_rdoc: