nuntium_api 0.20 → 0.21

data/README.md

@@ -0,0 +1,54 @@
+# nuntium-api-ruby
+
+Access the Nuntium API in Ruby.
+
+## Install
+
+    gem install nuntium_api
+
+## Gemfile
+
+    gem 'nuntium_api'
+
+## Example
+
+    require 'rubygems'
+    require 'nuntium'
+
+    api = Nuntium.new "service_url", "account_name", "application_name", "application_password"
+
+    message = {
+      :from => "sms://1234",
+      :to => "sms://5678",
+      :body => "Hello Nuntium!",
+    }
+
+    # Send an Application Originated message.
+    response = api.send_ao message
+
+    # Can also send many messages at once
+    messages = [{:to => "sms://1", :body => 'One'}, {:to => "sms://2", :body => 'Two'}]
+    response = api.send_ao messages
+
+    # Simulate sending and get a list of candidate channels
+    api.get_candidate_channels_for_ao message
+
+    # Get all countries
+    countries = api.countries
+
+    # Get all carriers that belong to a specific country
+    carriers = api.carriers countries[0].iso2
+
+    # Get all channels
+    channels = api.channels
+
+    # Create a channel
+    api.create_channel {
+      :name => "my_channel",
+      :kind => "clickatell",
+      :protocol => "sms",
+      :direction =>"bidirectional",
+      :enabled => true,
+      :priority => 10,
+      :configuration => {:password => "secret"}
+    }

data/lib/nuntium.rb

@@ -265,6 +265,14 @@ class Nuntium
     end
   end
 
+  # Returns a URL to authorize the given twitter channel, which will eventually redirect
+  # to the given callback URL.
+  #
+  # Raises Nuntium::Exception 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 Nuntium::Exception if something goes wrong.
@@ -314,6 +322,14 @@ class Nuntium
     end
   end
 
+  def get_text(path)
+    get(path) do |response, error|
+      raise Nuntium::Exception.new error.message if error
+
+      response.body
+    end
+  end
+
   def get_channels(path)
     get(path) do |response, error|
       raise Nuntium::Exception.new error.message if error

metadata

@@ -1,93 +1,101 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: nuntium_api
-version: !ruby/object:Gem::Version 
-  hash: 35
+version: !ruby/object:Gem::Version
+  version: '0.21'
   prerelease: 
-  segments: 
-  - 0
-  - 20
-  version: "0.20"
 platform: ruby
-authors: 
+authors:
 - InsTEDD
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-11-11 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rest-client
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: json
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
-description: Access the Nuntium API in ruby. Nuntium is an open source and free platform -developed by InSTEDD- that allows applications to send and receive all type of messages. Examples of messages are sms, emails and twitter direct messages.
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Access the Nuntium API in ruby. Nuntium is an open source and free platform
+  -developed by InSTEDD- that allows applications to send and receive all type of
+  messages. Examples of messages are sms, emails and twitter direct messages.
 email: aborenszweig@manas.com.ar
 executables: []
-
 extensions: []
-
-extra_rdoc_files: []
-
-files: 
+extra_rdoc_files:
+- README.md
+files:
 - lib/nuntium_api.rb
 - lib/nuntium.rb
 - lib/nuntium/exception.rb
-homepage: http://code.google.com/p/nuntium-api-ruby
+- README.md
+homepage: https://bitbucket.org/instedd/nuntium-api-ruby/src
 licenses: []
-
 post_install_message: 
-rdoc_options: []
-
-require_paths: 
+rdoc_options:
+- --charset=UTF-8
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.8
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Access the Nuntium API in ruby
 test_files: []
-
+has_rdoc: