octopush-ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 79587279ddd4490aa739dec956b749a592deed5b
+  data.tar.gz: 45b2941fa22fbb20bc53e6d62a2d304f21a9159f
+SHA512:
+  metadata.gz: ec1590872b28b5c517ae56e173ee326c022c680c63288412f5c521dd19841be8f15494c84cdabc363388dbae43565595d3813de9115a13b0f338bb66e2d4e019
+  data.tar.gz: 364bdb07e2a0cf77f2f0cd1aeab69bd9b1be913edd4cfbcfd3ddebcc7bb756cae953fd19741375303b69295c89ae790021d27905ba965e87f81fed2018a80027

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+*.gem

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Makefile

@@ -0,0 +1,7 @@
+.PHONY: test
+
+console:
+	irb -Ilib -roctopush-ruby
+
+test:
+	cutest test/*.rb

data/README.mkd

@@ -0,0 +1,74 @@
+# octopush-ruby
+
+A ruby library for use [Octopush API](http://www.octopush.com/en/sms-api).
+
+## Installation
+
+You can install via
+```bash
+gem install octopush-ruby
+```
+or if you are using bundler, by adding to your Gemfile
+```ruby
+gem 'octopush-ruby'
+```
+
+## Usage
+
+### Setup user
+
+First you need to setup an user login and api key to use with octopush.
+You can register at [octopush.com](http://www.octopush.com/en/registration) to get one
+
+```ruby
+require 'octopush-ruby'
+
+# setup your own credentials
+Octopush.configure do |config|
+  config.user_login = 'your_user_login'
+  config.api_key = 'your_api_key'
+end
+
+# then you can initiate a new client to use
+
+client = Octopush::Client.new
+```
+
+### Send SMS
+
+```ruby
+# first needs to create a sms instance
+sms = Octopush::SMS.new
+
+# set your desired attributes
+sms.sms_text = 'some text'
+sms.sms_recipients = '+33600000000'
+sms.sms_type = 'FR'
+
+# then just send the sms with the client you created before
+client.send_sms(sms)
+```
+
+### Check Balance
+
+```ruby
+client.get_balance
+```
+
+### Update user options
+
+```ruby
+client.edit_options({answer_email: 'some@email.com', sms_alert_type: 'FR'})
+```
+
+### Create sub account
+
+```ruby
+client.create_sub_account('Name', 'LastName', 'Raison', '234', 'FR')
+```
+
+### Credit sub account
+
+```ruby
+client.credit_sub_account('sub_account@email.com', '500', 'FR')
+```

data/lib/octopush-ruby.rb

@@ -0,0 +1,14 @@
+require 'octopush-ruby/configuration'
+require 'octopush-ruby/constants'
+require 'octopush-ruby/client'
+
+module Octopush
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+end

data/lib/octopush-ruby/client.rb

@@ -0,0 +1,154 @@
+require 'net/http'
+require 'nori'
+require 'digest/sha1'
+require 'octopush-ruby/sms'
+
+module Octopush
+  class Client
+    def initialize
+      raise "Should set user configuration before use" if Octopush.configuration.nil?
+
+      @constants = Octopush::Constants
+      @domain = @constants::DOMAIN
+    end
+
+    # update user options
+    # args should be a hash with the options that you want to update
+    # could be answer_email, sms_alert_bound, sms_alert_type
+    # @example
+    #   {answer_email: 'an_email@domain.com'}
+    def edit_options *args
+      path = @constants::PATH_EDIT_OPTIONS
+      data = user_hash.merge args[0]
+      res = request @domain, path, data
+    end
+
+    # returns current user's balance
+    # return a hash in the form: {balance_type => balance}
+    def get_balance
+      path = @constants::PATH_BALANCE
+      data = user_hash
+      response = request @domain, path, data
+
+      h = {}
+      response["balance"].each do |balance|
+        h = h.merge(balance.attributes["type"] => balance)
+      end
+
+      h
+    end
+
+    # send a sms
+    #   sms - a Octopush::SMS instance
+    #   sending_date - a date to send sms, required if sms_mode is DIFFERE,
+    #                  check Octopush::Constants::SMS_MODES for modes allowed
+    #   request_keys - Lists the key fields of the application you want to add
+    #                  in the sha1 hash. Check Octopush::Constants::REQUEST_KEYS
+    def send_sms sms, sending_date=nil, request_keys=nil
+      raise 'require a sms object' if sms.class != Octopush::SMS
+
+      path = @constants::PATH_SMS
+      data = user_hash.merge(sms.variables_hash)
+
+      if data[:sms_mode] == @constants::SMS_MODES['DIFFERE']
+        raise 'Need specify sending_date for DIFFERE mode' if sending_date.nil?
+        data = data.merge(sending_date: sending_date)
+      end
+
+      if !request_keys.nil?
+        sha1 = get_request_sha1_string(request_keys)
+        data = data.merge(request_keys: request_keys, request_sha1: sha1)
+      end
+
+      res = request @domain, path, data
+    end
+
+    # create sub account
+    #   first_name
+    #   last_name
+    #   raison_sociable
+    #   alert_bound
+    #   alert_sms_type - check Octopush::Constants::SMS_TYPES
+    def create_sub_account first_name, last_name, raison_sociable, alert_bound,
+                           alert_sms_type
+      path = @constants::PATH_SUB_ACCOUNT
+      data = user_hash.merge( first_name: first_name,
+                              last_name: last_name,
+                              raison_sociable: raison_sociable,
+                              alert_bound: alert_bound,
+                              alert_sms_type: alert_sms_type
+                            )
+      res = request @domain, path, data
+    end
+
+    # credit sub account
+    #   sub_account - sub account email
+    #   sms_amount - number of credits
+    #   sms_type - a sms type, check Octopush::Constants::SMS_TYPES
+    def credit_sub_account sub_account_email, sms_amount, sms_type
+      path = @constants::PATH_CREDIT_SUB_ACCOUNT_TOKEN
+      data = user_hash.merge(sub_account_email: sub_account_email)
+      res = request @domain, path, data
+      token_res = parse_response res.body
+
+      token = token_res['token']
+      path = @constants::PATH_CREDIT_SUB_ACCOUNT
+      if sms_type != 'FR' and sms_type != 'XXX'
+        sms_type = 'FR'
+      end
+
+      data = data.merge(sms_number: sms_amount,
+                        sms_type: sms_type,
+                        token: token)
+
+      res = request @domain, path, data
+    end
+
+    private
+
+    def user_hash
+      {
+        user_login: Octopush.configuration.user_login,
+        api_key: Octopush.configuration.api_key
+      }
+    end
+
+    def request domain, path, data, ssl=false
+      prefix = ssl ? 'https://' : 'http://'
+      url = prefix + domain + path
+      uri = URI url
+      req = Net::HTTP::Post.new uri.path
+      req.set_form_data data
+      res = Net::HTTP.start(uri.host, uri.port) do |http|
+        http.request(req)
+      end
+      parse_response res.body
+    end
+
+    # octopush api returns a xml after each request.
+    # We parse the xml to hash for more easy use
+    def parse_response response
+      parser = Nori.new
+      res_hash = parser.parse response
+      code = res_hash["octopush"]["error_code"]
+      if code != "000"
+        raise Octopush::Constants::ERRORS[code]
+      else
+        res_hash["octopush"]
+      end
+    end
+
+    # get a sha1 string in base to request_keys
+    def get_request_sha1_string request_keys, data
+      char_to_field = @constants::REQUEST_KEYS
+      request_string = ''
+      request_keys.split('').each do |key|
+        if !char_to_field[key].nil? and !data[char_to_field[key].to_sym].nil?
+          request_string += data[char_to_field[key].to_sym]
+        end
+      end
+
+      Digest::SHA1.hexdigest request_string
+    end
+  end
+end

data/lib/octopush-ruby/configuration.rb

@@ -0,0 +1,5 @@
+module Octopush
+  class Configuration
+    attr_accessor :user_login, :api_key
+  end
+end

data/lib/octopush-ruby/constants.rb

@@ -0,0 +1,106 @@
+module Octopush
+  class Constants
+    VERSION = '1.0.0'
+    DOMAIN = 'www.octopush-dm.com'
+    PORT = 80;
+    API_PATH = '/api'
+    API_SUB_PATH = '/api_sub'
+    PATH_SMS = API_PATH + '/sms'
+    PATH_BALANCE = API_PATH + '/balance'
+    PATH_SUB_ACCOUNT = API_SUB_PATH + '/add_sub_account'
+    PATH_CREDIT_SUB_ACCOUNT_TOKEN = API_SUB_PATH + '/credit_sub_account_get_session'
+    PATH_CREDIT_SUB_ACCOUNT = API_SUB_PATH + '/credit_sub_account'
+    PATH_OSTP = API_PATH + '/open_single_temp_session'
+    PATH_EDIT_OPTIONS = API_PATH + '/edit_options'
+    PATH_GET_USER_INFO = API_SUB_PATH + '/get_user_info'
+    SMS_TYPES = {
+      'SMS_STANDARD' => 'XXX',
+      'SMS_WORLD' => 'WWW',
+      'SMS_PREMIUM' => 'FR'
+    }
+    SMS_MODES = {
+      'INSTANTANE' => 1,
+      'DIFFERE' => 2
+    }
+    REQUEST_MODES = {
+      'SIMULATION' => 'simu',
+      'REEL' => 'real'
+    }
+    ERRORS = {
+      '100'=> 'POST request missing.',
+      '101'=> 'Incorrect login details.',
+      '102'=> 'Your SMS exceeds 160 characters',
+      '103'=> 'Your message has no recipients',
+      '104'=> 'You have run out of credit.',
+      '105'=> 'You don\'t have enough credit on your balance, but your last order is waiting for being validated',
+      '106'=> 'You have entered the Sender incorrectly. 3 to 11 characters, chosen from 0 to 9, a to z, A to Z. No accent, space or punctuation.',
+      '107'=> 'The text of your message is missing.',
+      '108'=> 'You have not entered your login details.',
+      '109'=> 'You have not entered your password.',
+      '110'=> 'You have not entered the list of recipient.',
+      '111'=> 'You have not chosen a way to enter your recipients.',
+      '112'=> 'You have not defined the quality of your message.',
+      '113'=> 'Your account is not validated. Log in Octopush and go to the "User interface" section.',
+      '114'=> 'You are under investigation for the fraudulent use of our services.',
+      '115'=> 'The recipient number is different from the number of one of the parameters that you have related it to.',
+      '116'=> 'The mailing option only works by using a contact list.',
+      '117'=> 'Your recipient list contains no correct numbers. Have you formatted your numbers by including the international dialling code? Contact us if you have any problems.',
+      '118'=> 'You must tick one of the two boxes to indicate if you do not wish to send test SMS or if you have correctly received and validated it.',
+      '119'=> 'You cannot send SMS with more than 160 characters for this type of SMS',
+      '120'=> 'A SMS with the same request_id has already been sent.',
+      '121'=> 'In Premium SMS, the mention "STOP au XXXXX" is mandatory and must belong to your text (respect the case).',
+      '122'=> 'In Standard SMS, the mention "no PUB=STOP" is mandatory and must belong to your text (respect the case).',
+      '123'=> 'The field request_sha1 is missing.',
+      '124'=> 'The field request_sha1 does not match. The data is wrong, or the query string contains an error or the frame contains an error : the request is rejected.',
+      '125'=> 'An undefined error has occurred. Please contact support.',
+      '126'=> 'An SMS campaign is already waiting for approval to send. You must validate or cancel it in order to start another.',
+      '127'=> 'An SMS campaign is already being processed. You must wait for processing to be completed in order to start another.',
+      '128'=> 'Too many attempts have been made. You need to start a new campaign.',
+      '129'=> 'Campaign is being built.',
+      '130'=> 'Campagne has not been set as finished.',
+      '131'=> 'Campaign not found.',
+      '132'=> 'Campaign sent.',
+      '133'=> 'The user_batch_id has already been used',
+      '150'=> 'No country was found for this prefix.',
+      '151'=> 'The recipient country is not part of the countries serviced by Octopush.',
+      '152'=> 'You cannot send low cost SMS to this country. Choose Premium SMS',
+      '153'=> 'The route is congested. This type of SMS cannot be dispatched immediately. If your order is urgent, please use another type of SMS.',
+      '201'=> 'This option is only available on request. Do not hesitate to request access if you need it.',
+      '202'=> 'The email account you wish to credit is incorrect.',
+      '203'=> 'You already have tokens in use. You can only have one session open at a time.',
+      '204'=> 'You specified a wrong token.',
+      '205'=> 'The number of text messages you want to transfer is too low.',
+      '206'=> 'You may not run campaigns during a credit transfer.',
+      '207'=> 'You do not have access to this feature.',
+      '208'=> 'Wrong type of SMS.',
+      '209'=> 'You are not allowed to send SMS messages to this user.',
+      '210'=> 'This email is not specified in any of your sub accounts or affiliate users.',
+      '300'=> 'You are not authorized to manage your lists by API.',
+      '301'=> 'You have reached the maximum number of lists.',
+      '302'=> 'A list with the same name already exists.',
+      '303'=> 'The specified list does not exist.',
+      '304'=> 'The list is already full.',
+      '305'=> 'There are too many contacts in the query.',
+      '306'=> 'The requested action is unknown.',
+      '308'=> 'Error of file.',
+      '500'=> 'Impossible to process the requested action',
+      '501'=> 'Connection error. Please contact our customer support'
+    }
+    REQUEST_KEYS = {
+      'T'	 => 'sms_text',
+      'R'	 => 'sms_recipients',
+      'M'	 => 'sms_mode',
+      'Y'	 => 'sms_type',
+      'S'	 => 'sms_sender',
+      'D'	 => 'sms_date',
+      'a'	 => 'recipients_first_names',
+      'b'	 => 'recipients_last_names',
+      'c'	 => 'sms_fields_1',
+      'd'	 => 'sms_fields_2',
+      'e'	 => 'sms_fields_3',
+      'W'	 => 'with_replies',
+      'N'	 => 'transactional',
+      'Q'	 => 'request_id'
+    }
+  end
+end

data/lib/octopush-ruby/sms.rb

@@ -0,0 +1,21 @@
+module Octopush
+  class SMS
+    attr_accessor :sms_text, :sms_recipients, :recipients_first_names,
+                  :recipients_last_names, :sms_fields1, :sms_fields2,
+                  :sms_fields3, :sms_mode, :sms_type, :sms_sender,
+                  :request_mode, :request_id, :with_replies, :transactional,
+                  :msisdn_sender
+
+    def variables_hash
+      hash = {}
+      self.instance_variables.each do |variable|
+        var = variable.to_s.sub('@', '')
+        key = var.to_sym
+        value = self.send(var)
+        hash = hash.merge(key => value)
+      end
+
+      hash
+    end
+  end
+end

data/octopush-ruby.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+  s.name = "octopush-ruby"
+  s.version = "0.0.1"
+  s.summary = "A ruby library for use Octopush API"
+  s.description = s.summary
+  s.authors = ["César Carruitero"]
+  s.email = ["cesar@mozilla.pe"]
+  s.homepage = "https://github.com/ccarruitero/octopush-ruby"
+  s.license = "MIT"
+
+  s.files = `git ls-files`.split("\n")
+
+  s.add_runtime_dependency "nori"
+  s.add_development_dependency "cutest"
+end

data/test/helper.rb

@@ -0,0 +1,2 @@
+require 'cutest'
+require_relative '../lib/octopush-ruby'

data/test/octopush_test.rb

@@ -0,0 +1,22 @@
+require_relative 'helper'
+include Octopush
+
+scope do
+  setup do
+    Octopush.configure do |c|
+      c.user_login = 'mymail@example.com'
+    end
+  end
+
+  test "sha1 string" do
+    data = {sms_text: 'fasgsagasg'}
+    cli = Octopush::Client.new
+    sha1 = cli.send(:get_request_sha1_string, 'T', data)
+    assert_equal "4ba873f39c4ca45c67ab281e75ca23779d72bf2a", sha1
+
+    data = {sms_text: 'fasgsagasg', sms_recipients: '+51948372820'}
+    cli = Octopush::Client.new
+    sha1 = cli.send(:get_request_sha1_string, 'TR', data)
+    assert_equal "53dfcf057931579e382e76a96f79e32d3d01c014", sha1
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: octopush-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- César Carruitero
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nori
+  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: cutest
+  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: A ruby library for use Octopush API
+email:
+- cesar@mozilla.pe
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Makefile
+- README.mkd
+- lib/octopush-ruby.rb
+- lib/octopush-ruby/client.rb
+- lib/octopush-ruby/configuration.rb
+- lib/octopush-ruby/constants.rb
+- lib/octopush-ruby/sms.rb
+- octopush-ruby.gemspec
+- test/helper.rb
+- test/octopush_test.rb
+homepage: https://github.com/ccarruitero/octopush-ruby
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A ruby library for use Octopush API
+test_files: []