instedd-pigeon 0.1.3 → 0.2.0

data/.rspec

@@ -0,0 +1,2 @@
+--color
+

data/app/helpers/pigeon/channel_helper.rb

@@ -24,6 +24,12 @@ module Pigeon
           choices = choices.map { |h| [h["display"], h["value"]] }
         end
         select_tag(field_name, options_for_select(choices, field_value), options)
+      when "multi"
+        choices = attribute.options
+        if choices.length > 0 && choices[0].is_a?(Hash)
+          choices = choices.map { |h| [h["display"], h["value"]] }
+        end
+        select_tag(field_name, options_for_select(choices, field_value), { :multiple => true }.merge(options))
       when "timezone"
         select_tag(field_name, time_zone_options_for_select(field_value), options)
       when "boolean"

data/app/models/pigeon/channel.rb

@@ -7,6 +7,10 @@ module Pigeon
     include NestedScopes
 
     class << self
+      def i18n_scope
+        :pigeon
+      end
+
       def type() nil end
 
       def schemas

data/app/models/pigeon/channel_attribute.rb

@@ -30,7 +30,7 @@ module Pigeon
     end
 
     def self.valid_type?(type)
-      %w(string boolean password enum integer timezone hidden).include?(type.to_s)
+      %w(string boolean password enum multi integer timezone hidden).include?(type.to_s)
     end
 
     def self.build_default(name, hint_value = nil)

data/app/models/pigeon/nuntium_channel.rb

@@ -15,7 +15,7 @@ module Pigeon
       end
 
       def nuntium
-        @nuntium ||= Nuntium.from_config
+        @nuntium ||= ::Pigeon::Nuntium.from_config
       end
 
     private
@@ -25,7 +25,13 @@ module Pigeon
       end
 
       def load_schemas
-        Pigeon::ChannelSchema.list_from_hash(:nuntium, PigeonConfig::NuntiumChannelSchemas)
+        if Pigeon.config.nuntium_configured?
+          Pigeon::ChannelSchema.list_from_hash(:nuntium, PigeonConfig::NuntiumChannelSchemas).reject do |schema|
+            schema.kind == 'twitter' && !Pigeon.config.twitter_configured?
+          end
+        else
+          []
+        end
       end
     end
 
@@ -49,7 +55,7 @@ module Pigeon
           self.class.nuntium.update_channel attributes
         end
         true
-      rescue Nuntium::Exception => e
+      rescue Pigeon::NuntiumException => e
         Rails.logger.warn "error saving Nuntium channel: #{e.message}"
         e.properties.each do |name, message|
           if attributes.include? name
@@ -71,7 +77,7 @@ module Pigeon
             self.class.nuntium.delete_channel(name)
           end
           @destroyed = true
-        rescue Nuntium::Exception => e
+        rescue Pigeon::NuntiumException => e
           Rails.logger.warn "error deleting Nuntium channel: #{e.message}"
         end
       end

data/app/models/pigeon/verboice_channel.rb

@@ -13,7 +13,7 @@ module Pigeon
       end
 
       def verboice
-        @verboice ||= Verboice.from_config
+        @verboice ||= ::Pigeon::Verboice.from_config
       end
 
     private
@@ -23,7 +23,11 @@ module Pigeon
       end
 
       def load_schemas
-        Pigeon::ChannelSchema.list_from_hash(:verboice, PigeonConfig::VerboiceChannelSchemas)
+        if Pigeon.config.verboice_configured?
+          Pigeon::ChannelSchema.list_from_hash(:verboice, PigeonConfig::VerboiceChannelSchemas)
+        else
+          []
+        end
       end
     end
 
@@ -39,7 +43,6 @@ module Pigeon
       return false unless valid?
 
       begin
-        puts attributes
         if !persisted?
           self.class.verboice.create_channel attributes
           @persisted = true
@@ -47,7 +50,7 @@ module Pigeon
           self.class.verboice.update_channel attributes
         end
         true
-      rescue Verboice::Exception => e
+      rescue Pigeon::VerboiceException => e
         Rails.logger.warn "error saving Verboice channel: #{e.message}"
         e.properties.each do |name, message|
           if attributes.include? name
@@ -69,7 +72,7 @@ module Pigeon
             self.class.verboice.delete_channel(name)
           end
           @destroyed = true
-        rescue Verboice::Exception => e
+        rescue Pigeon::VerboiceException => e
           Rails.logger.warn "error deleting Verboice channel: #{e.message}"
         end
       end

data/config/locales/en.yml

@@ -0,0 +1,6 @@
+en:
+  pigeon:
+    errors:
+      messages:
+        channel_invalid: "Validation failed: %{errors}"
+

data/config/schemas/nuntium/nuntium.yml

@@ -34,6 +34,9 @@ clickatell:
           type: password
           humanized_name: Incoming password
           label: Incoming password (to use for the callback URLs)
+        - name: cost_per_credit
+          label: "Cost per credit (messages will get a 'cost' custom attribute with the value charge * cost_per_credit)"
+          default_value: 1
 
 dtac:
   humanized_name: 'DTAC channel'
@@ -43,7 +46,7 @@ dtac:
       user: false
     - name: configuration
       attributes:
-        - name: username
+        - name: user
         - name: password
           type: password
 
@@ -53,14 +56,20 @@ ipop:
     - name: protocol
       value: sms
       user: false
+    - name: address
+      humanized_name: From address
+      label: 'Address (this is usually the "from" number)'
     - name: configuration
       attributes:
-        - name: url
-          label: URL
-        - name: username
+        - name: mt_post_url
+          humanized_name: Post URL
+          label: Post URL
+        - name: mt_post_user
+          humanized_name: Username
           label: Username (optional)
-        - name: password
+        - name: mt_post_password
           type: password
+          humanized_name: Password
           label: Password (optional)
         - name: cid
           label: Connection ID (cid)
@@ -85,6 +94,9 @@ isms:
     - name: protocol
       value: sms
       user: false
+    - name: address
+      humanized_name: From address
+      label: 'Address (this is usually the "from" number)'
     - name: configuration
       attributes:
         - name: host
@@ -131,28 +143,6 @@ qst:
         - name: password
           type: password
 
-smpp:
-  humanized_name: 'SMPP channel'
-  attributes:
-    - name: protocol
-      value: sms
-      user: false
-    - name: configuration
-      attributes:
-        - name: host
-        - name: port
-          type: integer
-        - name: user
-        - name: password
-          type: password
-        - name: system_type
-          default_value: vma
-        - name: source_ton
-        - name: source_npi
-        - name: destination_ton
-        - name: destination_npi
-        - name: service_type
-
 smtp:
   humanized_name: 'SMTP channel'
   attributes:

data/config/schemas/nuntium/smpp.yml

@@ -0,0 +1,71 @@
+smpp:
+  humanized_name: 'SMPP channel'
+  attributes:
+    - name: protocol
+      value: sms
+      user: false
+    - name: configuration
+      attributes:
+        - name: host
+        - name: port
+          type: integer
+        - name: user
+        - name: password
+          type: password
+        - name: system_type
+          default_value: vma
+        - name: source_ton
+        - name: source_npi
+        - name: destination_ton
+        - name: destination_npi
+        - name: service_type
+        - name: endianness_mo
+          type: boolean
+          label: 'Use little endian for UCS-2 MO messages'
+        - name: endianness_mt
+          type: boolean
+          label: 'Use little endian for UCS-2 MT messages'
+        - name: accept_mo_hex_string
+          type: boolean
+          humanized_name: 'Hex strings'
+        - name: default_mo_encoding
+          type: enum
+          options:
+            - value: 'ascii'
+              display: 'ASCII'
+            - value: 'latin1'
+              display: 'Latin1'
+            - value: 'ucs-2'
+              display: 'UCS-2'
+            - value: 'gsm'
+              display: 'GSM 03.38'
+        - name: mt_encodings
+          type: multi
+          options:
+            - value: 'ascii'
+              display: 'ASCII'
+            - value: 'latin1'
+              display: 'Latin1'
+            - value: 'ucs-2'
+              display: 'UCS-2'
+        - name: mt_max_length
+          type: enum
+          options:
+            - 140
+            - 160
+            - 254
+        - name: mt_csms_method
+          type: enum
+          options:
+            - value: 'udh'
+              display: 'UDH'
+            - value: 'optional_parameters'
+              display: 'Optional parameters'
+            - value: 'message_payload'
+              display: 'Message payload'
+          default_value: 'optional_parameters'
+        - name: suspension_codes
+          label: 'Suspension codes (comma separated)'
+        - name: rejection_codes
+          label: 'Rejection codes (comma separated)'
+

data/lib/pigeon.rb

@@ -9,6 +9,18 @@ module Pigeon
     attr_accessor :verboice_default_call_flow
 
     attr_accessor :twitter_consumer_key, :twitter_consumer_secret
+
+    def nuntium_configured?
+      nuntium_host.present? && nuntium_account.present? && nuntium_app.present? && nuntium_app_password.present?
+    end
+
+    def verboice_configured?
+      verboice_host.present? && verboice_account.present? && verboice_password.present?
+    end
+
+    def twitter_configured?
+      twitter_consumer_key.present? && twitter_consumer_secret.present?
+    end
   end
 
   def self.config

data/lib/pigeon/errors.rb

@@ -7,6 +7,8 @@ module Pigeon
 
     def initialize(channel)
       @channel = channel
+      errors = @channel.errors.full_messages.join(", ")
+      super(I18n.t(:"#{@channel.class.i18n_scope}.errors.messages.channel_invalid", :errors => errors, :default => :"errors.messages.channel_invalid"))
     end
   end
 
@@ -24,5 +26,21 @@ module Pigeon
       })  
     end 
   end
+
+  class ApiException < PigeonError
+    attr_accessor :properties
+
+    def initialize(msg, properties = {})
+      super msg
+      @properties = properties
+    end
+  end
+  
+  class VerboiceException < ApiException
+  end
+
+  class NuntiumException < ApiException
+  end
+
 end
 

data/lib/pigeon/nuntium.rb

@@ -1,10 +1,295 @@
-require 'nuntium'
+# Provides access to the Nuntium Public API.
+# Taken from the nuntium-api-ruby gem version 0.21
+# See http://bitbucket.org/instedd/nuntium-api-ruby
 
-class Nuntium
-  def self.from_config
-    config = Pigeon.config
+require 'net/http'
+require 'json'
+require 'rest_client'
+require 'cgi'
+require 'pigeon/errors'
+require 'pigeon/utils'
+
+module Pigeon
+  class Nuntium
+    include Pigeon::Utils
+
+    def self.error_class
+      Pigeon::NuntiumException
+    end
+
+    def self.from_config
+      config = Pigeon.config
+
+      Nuntium.new config.nuntium_host, config.nuntium_account, config.nuntium_app, config.nuntium_app_password
+    end
+
+    # Creates an application-authenticated Nuntium api access.
+    def initialize(url, account, application, password)
+      @url = url
+      @account = account
+      @application = application
+      @options = {
+        :user => "#{account}/#{application}",
+        :password => password,
+        :headers => {:content_type => 'application/json'},
+      }
+    end
+
+    # Gets the list of countries known to Nuntium as an array of hashes.
+    #
+    # Raises ::Pigeon::NuntiumException if something goes wrong.
+    def countries
+      get_json "/api/countries.json"
+    end
+
+    # Gets a country as a hash given its iso2 or iso3 code, or nil if a country with that iso does not exist.
+    #
+    # Raises ::Pigeon::NuntiumException if something goes wrong.
+    def country(iso)
+      get_json "/api/countries/#{iso}.json"
+    end
+
+    # Gets the list of carriers known to Nuntium that belong to a country as an array of hashes, given its
+    # iso2 or iso3 code. Gets all carriers as an array of hashes if no country is specified.
+    #
+    # Raises ::Pigeon::NuntiumException if something goes wrong.
+    def carriers(country_id = nil)
+      if country_id
+        get_json "/api/carriers.json?country_id=#{country_id}"
+      else
+        get_json "/api/carriers.json"
+      end
+    end
+
+    # Gets a carrier as a hash given its guid, or nil if a carrier with that guid does not exist.
+    #
+    # Raises ::Pigeon::NuntiumException if something goes wrong.
+    def carrier(guid)
+      get_json "/api/carriers/#{guid}.json"
+    end
+
+    # Returns the list of channels belonging to the application or that don't
+    # belong to any application, as an array of hashes.
+    #
+    # Raises ::Pigeon::NuntiumException if something goes wrong.
+    def channels
+      get "/api/channels.json" do |response, error|
+        raise ::Pigeon::NuntiumException.new error.message if error
+
+        channels = JSON.parse response.body
+        channels.map! do |channel|
+          read_configuration channel
+          with_indifferent_access channel
+        end
+        channels
+      end
+    end
+
+    # Returns a channel given its name. Raises when the channel does not exist.
+    #
+    # Raises ::Pigeon::NuntiumException if something goes wrong.
+    def channel(name)
+      get("/api/channels/#{name}.json") do |response, error|
+        raise ::Pigeon::NuntiumException.new error.message if error
+
+        channel = JSON.parse response.body
+        read_configuration channel
+        with_indifferent_access channel
+      end
+    end
+
+    # Creates a channel.
+    #
+    #   create_channel :name => 'foo', :kind => 'qst_server', :protocol => 'sms', :configuration => {:password => 'bar'}
+    #
+    # Raises ::Pigeon::NuntiumException if something goes wrong. You can access specific errors on properties via the properties
+    # accessor of the exception.
+    def create_channel(channel)
+      channel = channel.dup
+
+      write_configuration channel
+      post "/api/channels.json", channel.to_json do |response, error|
+        handle_channel_error error if error
+
+        channel = JSON.parse response.body
+        read_configuration channel
+        with_indifferent_access channel
+      end
+    end
+
+    # Updates a channel.
+    #
+    #   update_channel :name => 'foo', :kind => 'qst_server', :protocol => 'sms', :configuration => {:password => 'bar'}
+    #
+    # Raises ::Pigeon::NuntiumException if something goes wrong. You can access specific errors on properties via the properties
+    # accessor of the exception.
+    def update_channel(channel)
+      channel = channel.dup
+
+      write_configuration channel
+      channel_name = channel['name'] || channel[:name]
+
+      put "/api/channels/#{channel_name}.json", channel.to_json do |response, error|
+        handle_channel_error error if error
+
+        channel = JSON.parse response.body
+        read_configuration channel
+        with_indifferent_access channel
+      end
+    end
+
+    # Deletes a chnanel given its name.
+    #
+    # Raises ::Pigeon::NuntiumException if something goes wrong.
+    def delete_channel(name)
+      delete "/api/channels/#{name}" do |response, error|
+        raise ::Pigeon::NuntiumException.new error.message if error
+
+        response
+      end
+    end
+
+    # Returns the list of candidate channels when simulating routing the given AO message.
+    #
+    #   candidate_channels_for_ao :from => 'sms://1', :to => 'sms://2', :subject => 'hello', :body => 'hi!'
+    #
+    # Raises ::Pigeon::NuntiumException if something goes wrong.
+    def candidate_channels_for_ao(message)
+      get_channels "/api/candidate/channels.json?#{to_query message}"
+    end
+
+    # Sends one or many AO messages.
+    #
+    # To send a token, just include it in the message as :token => 'my_token'
+    #
+    #   send_ao :from => 'sms://1', :to => 'sms://2', :subject => 'hello', :body => 'hi!'
+    #   send_ao [{:from => 'sms://1', :to => 'sms://2', :subject => 'hello', :body => 'hi!'}, {...}]
+    #
+    # Returns a hash with :id, :guid and :token keys if a single message was sent, otherwise
+    # returns a hash with a :token key.
+    #
+    # Raises ::Pigeon::NuntiumException if something goes wrong.
+    def send_ao(messages)
+      if messages.is_a? Array
+        post "/#{@account}/#{@application}/send_ao.json", messages.to_json do |response, error|
+          raise ::Pigeon::NuntiumException.new error.message if error
+
+          with_indifferent_access({:token => response.headers[:x_nuntium_token]})
+        end
+      else
+        get "/#{@account}/#{@application}/send_ao?#{to_query messages}" do |response, error|
+          raise ::Pigeon::NuntiumException.new error.message if error
+
+          with_indifferent_access(
+            {
+              :id => response.headers[:x_nuntium_id],
+              :guid => response.headers[:x_nuntium_guid],
+              :token => response.headers[:x_nuntium_token],
+            }
+          )
+        end
+      end
+    end
+
+    # Gets AO messages that have the given token. The response is an array of hashes with the messages' attributes.
+    #
+    # Raises ::Pigeon::NuntiumException if something goes wrong.
+    def get_ao(token)
+      get_json "/#{@account}/#{@application}/get_ao.json?token=#{token}"
+    end
+
+    # Gets the custom attributes specified for a given address. Returns a hash with the attributes
+    #
+    # Raises ::Pigeon::NuntiumException if something goes wrong.
+    def get_custom_attributes(address)
+      get_json "/api/custom_attributes?address=#{address}"
+    end
+
+    # Sets custom attributes of a given address.
+    #
+    # Raises ::Pigeon::NuntiumException if something goes wrong.
+    def set_custom_attributes(address, attributes)
+      post "/api/custom_attributes?address=#{address}", attributes.to_json do |response, error|
+        raise ::Pigeon::NuntiumException.new error.message if error
+
+        nil
+      end
+    end
+
+
+    # Creates a friendship between the channel's twitter account and the given user.
+    # Returns the response from twitter.
+    # Refer to Twitter's documentation: https://dev.twitter.com/docs/api/1/post/friendships/create
+    #
+    # Raises ::Pigeon::NuntiumException if something goes wrong.
+    def twitter_friendship_create(channel_name, user, follow = true)
+      get("/api/channels/#{channel_name}/twitter/friendships/create?user=#{CGI.escape user}&follow=#{follow}") do |response, error|
+        raise ::Pigeon::NuntiumException.new error.message if error
+
+        response
+      end
+    end
+
+    # Returns a URL to authorize the given twitter channel, which will eventually redirect
+    # to the given callback URL.
+    #
+    # Raises ::Pigeon::NuntiumException if something goes wrong.
+    def twitter_authorize(channel_name, callback)
+      get_text("/api/channels/#{channel_name}/twitter/authorize?callback=#{CGI.escape callback}")
+    end
+
+    # Adds an xmpp conact to the xmpp account associated to the given channel.
+    #
+    # Raises ::Pigeon::NuntiumException if something goes wrong.
+    def xmpp_add_contact(channel_name, jid)
+      get("/api/channels/#{channel_name}/xmpp/add_contact?jid=#{CGI.escape jid}") do |response, error|
+        raise ::Pigeon::NuntiumException.new error.message if error
+
+        response
+      end
+    end
+
+    private
+
+    def write_configuration(channel)
+      return unless channel[:configuration] || channel['configuration']
+
+      configuration = []
+      (channel[:configuration] || channel['configuration']).each do |name, value|
+        configuration << {:name => name, :value => value}
+      end
+      if channel[:configuration]
+        channel[:configuration] = configuration
+      else
+        channel['configuration'] = configuration
+      end
+    end
+
+    def read_configuration(channel)
+      channel['configuration'] = Hash[channel['configuration'].map { |e| [e['name'], e['value']] }]
+    end
+
+    def get_text(path)
+      get(path) do |response, error|
+        raise ::Pigeon::NuntiumException.new error.message if error
+
+        response.body
+      end
+    end
+
+    def get_channels(path)
+      get(path) do |response, error|
+        raise ::Pigeon::NuntiumException.new error.message if error
+
+        channels = JSON.parse response.body
+        channels.map! do |channel|
+          read_configuration channel
+          with_indifferent_access channel
+        end
+        channels
+      end
+    end
 
-    Nuntium.new config.nuntium_host, config.nuntium_account, config.nuntium_app, config.nuntium_app_password
   end
 end