zensend 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 763343e142097259cb183048822aee92ae368ac0
+  data.tar.gz: ce842952d1c2b3bc5a1db29bf98fcbdfad1b2f2a
+SHA512:
+  metadata.gz: 699fe7f0819a9716a4a12250b742124fb2b624075979acd5373d6923db02e861620c83a34d403febb0873f0447c7e8f1fdd26c95b45f6c34f6e4b4972932e6c0
+  data.tar.gz: ef74cefbc3fe51f3e4852e6b09e00b197f36fd279599ba7606e66a28d438d604efdeeb2cf0e845079d56cf2ec482c9bab35b472fa260387be170cabf5fcb5975

data/lib/zensend.rb

@@ -0,0 +1,5 @@
+require "zensend/version"
+require 'zensend/client'
+require 'zensend/sms_response'
+require 'zensend/operator_lookup_response'
+require 'zensend/zensend_exception'

data/lib/zensend/client.rb

@@ -0,0 +1,125 @@
+require 'json'
+require 'net/http'
+
+module ZenSend
+
+
+  class Client
+
+    ZENSEND_URL     = "https://api.zensend.io"
+
+    attr_accessor :api_key, :url, :http_opts
+    
+    def initialize(api_key, http_opts = {open_timeout: 60, read_timeout: 60}, url = ZENSEND_URL)
+      @api_key = api_key
+      @url = url
+      @http_opts = http_opts
+    end
+
+    ##
+    # Sends an sms message
+    # 
+    # Named paramters:
+    #  originator: the originator to send from
+    #  body: the body of the sms message
+    #  numbers: an array of numbers to send to. they must not contain the ',' character
+    #  originator_type: :alpha or :msisdn (not required)
+    #  timetolive_in_minutes: number of minutes before message expires (not required)
+    #  encoding: :ucs2 or :gsm (not required defaults to automatic)
+    #
+    # A ZenSend::ZenSendException or StandardError or ArgumentError can be raised by this 
+    # method. StandardError is raised by net/http. It may be one of the following subclasses:
+    # [Errno::ETIMEDOUT, Errno::ECONNRESET, Errno::EHOSTUNREACH, SocketError, Net::ReadTimeout, Net::OpenTimeout]
+    # This list is not exhaustive.
+    #
+    # An ArgumentError can be raised if any of the numbers includes a ',' character or
+    # a required parameter is not specified or an unknown parameter is specified.
+    #
+    VALID_OPTIONS = [:originator, :body, :numbers, :originator_type, :timetolive_in_minutes, :encoding]
+
+    def send_sms(options)
+
+      originator = required_param(options, :originator)
+      body = required_param(options, :body)
+      numbers = required_param(options, :numbers)
+
+      raise ArgumentError.new("invalid character in numbers") if numbers.any? {|x| x.include?(",")}
+
+
+      options.keys.each do |key|
+        raise ArgumentError.new("unknown option: #{key}") if !VALID_OPTIONS.include?(key)
+      end
+
+      sms_response = SmsResponse.new
+
+      params = {"ORIGINATOR" => originator, "BODY" => body, "NUMBERS" => numbers.join(",")}
+      
+      add_optional_param(params, options, "ORIGINATOR_TYPE", :originator_type)
+      add_optional_param(params, options, "TIMETOLIVE", :timetolive_in_minutes)
+      add_optional_param(params, options, "ENCODING", :encoding)
+
+      
+
+      sms_response.set_from_response(make_request("/v3/sendsms", :post, params))
+
+      sms_response
+    end
+
+    def check_balance
+      response = make_request("/v3/checkbalance", :get)
+      response["balance"]
+    end
+
+    def get_prices
+      response = make_request("/v3/prices", :get)
+      response["prices_in_pence"]
+    end
+
+    def lookup_operator(msisdn)
+      operator_lookup_response = OperatorLookupResponse.new
+      operator_lookup_response.set_from_response(make_request("/v3/operator_lookup?" + URI.encode_www_form({"NUMBER" => msisdn}), :get))
+      operator_lookup_response
+    end
+
+    private
+
+    def add_optional_param(params, options, name, key)
+      params[name] = options[key] if options.include?(key)
+    end
+
+    def required_param(options, param)
+      raise ArgumentError.new("missing: #{param}") if !options.include?(param)
+      options[param]
+    end
+
+    def make_request(path, method, params = {})
+      uri = URI("#{@url}#{path}")
+
+      response = Net::HTTP.start(uri.hostname, uri.port, @http_opts.merge(:use_ssl => uri.scheme == "https")) {|http|
+
+        request = Net::HTTP::Post.new(uri.request_uri) if method == :post
+        request = Net::HTTP::Get.new(uri.request_uri) if method == :get
+
+        request['X-API-KEY'] = @api_key
+
+        request.set_form_data(params) if method == :post && params
+
+        http.request(request)
+      }
+
+      if !response.content_type.nil? && response.content_type.include?("application/json")
+        json_response = JSON.parse(response.body)
+        if json_response['success']
+          return json_response['success']
+        elsif json_response['failure']
+          failure = json_response['failure']
+          raise ZenSendException.new(response.code, failure["failcode"], failure["parameter"], failure["cost_in_pence"], failure["new_balance_in_pence"])
+        else
+          raise ZenSendException.new(response.code, nil, nil, nil, nil)
+        end
+      else
+        raise ZenSendException.new(response.code, nil, nil, nil, nil)
+      end
+    end
+  end
+end

data/lib/zensend/operator_lookup_response.rb

@@ -0,0 +1,15 @@
+module ZenSend
+  OperatorLookupResponse = Struct.new(:mnc, :mcc, :operator, :new_balance_in_pence, :cost_in_pence)
+
+  class OperatorLookupResponse
+
+    def set_from_response(response_hash)
+      self.mnc = response_hash["mnc"]
+      self.mcc = response_hash["mcc"]
+      self.operator = response_hash["operator"]
+      self.new_balance_in_pence = response_hash["new_balance_in_pence"]
+      self.cost_in_pence = response_hash["cost_in_pence"]
+    end
+
+  end
+end

data/lib/zensend/sms_response.rb

@@ -0,0 +1,16 @@
+module ZenSend
+  SmsResponse = Struct.new(:tx_guid, :numbers, :sms_parts, :encoding, :cost_in_pence, :new_balance_in_pence)
+
+  class SmsResponse
+
+    def set_from_response(response_hash)
+      self.tx_guid = response_hash["txguid"]
+      self.numbers = response_hash["numbers"]
+      self.sms_parts = response_hash["smsparts"]
+      self.encoding = response_hash["encoding"]
+      self.cost_in_pence = response_hash["cost_in_pence"]
+      self.new_balance_in_pence = response_hash["new_balance_in_pence"]
+    end
+
+  end
+end

data/lib/zensend/version.rb

@@ -0,0 +1,3 @@
+module ZenSend
+  VERSION = "0.0.1"
+end

data/lib/zensend/zensend_exception.rb

@@ -0,0 +1,13 @@
+module ZenSend
+  class ZenSendException < Exception
+    attr_reader :failcode, :parameter, :http_code, :cost_in_pence, :new_balance_in_pence
+
+    def initialize(http_code, failcode, parameter, cost_in_pence, new_balance_in_pence)
+      @http_code = http_code
+      @failcode = failcode
+      @parameter = parameter
+      @cost_in_pence = cost_in_pence
+      @new_balance_in_pence = new_balance_in_pence
+    end
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: zensend
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Fonix
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-23 00:00:00.000000000 Z
+dependencies:
+- !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: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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 simple REST API for ZenSend in Ruby
+email: tech@fonix.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/zensend/client.rb
+- lib/zensend/operator_lookup_response.rb
+- lib/zensend/sms_response.rb
+- lib/zensend/version.rb
+- lib/zensend/zensend_exception.rb
+- lib/zensend.rb
+homepage: http://rubygems.org/gems/zensend_ruby_api
+licenses:
+- FONIX
+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.0.14
+signing_key: 
+specification_version: 4
+summary: ZenSendr's REST API
+test_files: []