telesocial 0.0.2

data/Gemfile

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

data/README.markdown

@@ -0,0 +1,41 @@
+Telesocial API Ruby gem
+=======================
+
+Telesocial's free calling API enables mobile calling in social networks.
+This is a Ruby interface to [Telesocial API](http://sites.telesocial.com/docs/home).
+
+Installation
+------------
+
+    gem install telesocial
+
+Usage - Examples
+----------------
+```ruby
+require 'telesocial'
+client = Telesocial::Client.new('your_api_key') # Now, all telesocial methods are available to your client
+
+# Method calls on the client returns a simple object that matches
+# Telesocial's API response object.
+
+# Register a user with username "eric" and phone number: 4054441212
+response = client.register("eric", "4054441212")
+puts response.status # => 201
+puts response.uri # => "/api/rest/registrant/eric"
+
+# Check a user's registration status
+response = begin
+             client.get_registration_status('eric')
+           rescue Telesocial::NotFound
+             # Registration not found;
+           else
+              # Other errors
+           end
+
+# Upload a file to be played to a registered user
+media_id = client.create_media.mediaId
+upload_request_grant_id = client.request_upload_grant(media_id)
+
+uploaded_file_url = client.upload_file(upload_request_grant_id, "my_file_path.mp3")
+    
+```

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/telesocial/client.rb

@@ -0,0 +1,346 @@
+require 'httparty'
+require 'hashie'
+require 'net/http/post/multipart'
+require 'mime/types'
+
+module Telesocial
+  class Client
+    include HTTParty
+    base_uri 'https://api4.bitmouth.com'
+    disable_rails_query_string_format
+
+    class ResponseParser < HTTParty::Parser
+      def parse
+        begin
+          Hashie::Mash.new(Crack::JSON.parse(body).values.first)
+        rescue
+          body
+        end
+      end
+    end
+    parser ResponseParser
+
+    attr_reader :api_key
+
+    def initialize(api_key)
+      @api_key = api_key
+    end
+
+    def get_registration_status(network_id, query = "exists")
+
+      response = post("/api/rest/registrant/#{network_id}", :body => {:query => query, :appkey => @api_key})
+
+      case response.status
+      when 200
+        response.registered = true
+      when 401
+        raise Telesocial::Unauthorized.new("The network ID exists but it is not associated with the specified application", response)
+      when 404
+        raise Telesocial::NotFound.new("The device is not registered.", response)
+      else
+        raise Telesocial::Error.new(response.message, response)
+      end
+
+      return response
+    end
+
+    def register(network_id, phone, greeting_id = nil)
+      response = post("/api/rest/registrant/", :body => {:networkid => network_id, :phone => phone, :appkey => @api_key, :greetingid => greeting_id})
+
+      case response.status
+      when 201
+      when 400
+        raise Telesocial::BadRequest.new("One or more parameters were invalid or this (phone, networkid) pair is already registered.", response)
+      when 502
+        raise Telesocial::BadGateway.new("Unable to start the phone authorization process.", response)
+      else
+        raise Telesocial::Error.new(response.message, response)
+      end
+
+      response
+    end
+
+    def create_media()
+      response = post("/api/rest/media/", :body => {:appkey => @api_key})
+
+      case response.status
+      when 201
+      when 400
+        raise Telesocial::BadRequest.new("Missing parameter(s)", response)
+      when 404
+        raise Telesocial::NotFound.new("The application key is invalid.", response)
+      end
+
+      response
+    end
+
+    def record(network_id, media_id)
+      response = post("/api/rest/media/#{media_id}",:body => {:networkid => network_id, :appkey => @api_key, :action => "record"})
+
+      case response.status
+      when 201
+      when 400
+        raise Telesocial::BadRequest.new("Missing parameter(s).", response)
+      when 404
+        raise Telesocial::NotFound.new("The application key is invalid or the application is not associated with the networkid.", response)
+      when 502
+        raise Telesocial::BadGateway.new("Unable to initiate phone call at this time.", response)
+      end
+
+      response
+
+    end
+
+    def blast(network_id, media_id)
+      response = post("/api/rest/media/#{media_id}",:body => {:networkid => network_id, :appkey => @api_key, :action => "blast"})
+
+      case response.status
+      when 200,201,202
+      when 400
+        raise Telesocial::BadRequest.new("Missing parameter(s).", response)
+      when 404
+        raise Telesocial::NotFound.new("The application key is invalid or the application is not associated with the networkid.", response)
+      when 502
+        raise Telesocial::BadGateway.new("Unable to initiate phone call at this time.", response)
+      end
+
+      response
+    end
+
+    def request_upload_grant(media_id)
+      response = post("/api/rest/media/#{media_id}",:body => {:appkey => @api_key, :action => "upload_grant"})
+
+      case response.status
+      when 201,202
+      when 400
+        raise Telesocial::BadRequest.new("Missing or invalid parameter(s).", response)
+      when 401
+        raise Telesocial::Unauthorized.new("The media ID is invalid or is not associated with the application identified by the appkey parameter.", response)
+      end
+
+      response
+    end
+
+    def media_status(media_id)
+      response = get("/api/rest/media/status/#{media_id}", :query => {:appkey => @api_key})
+
+      case response.status
+      when 200,201,202
+      when 204
+        raise Telesocial::NoContent.new("No media content exists for this Media ID.", response)
+      when 404
+        raise Telesocial::NotFound.new("The application key or networkid are invalid.", response)
+      end
+
+      response
+    end
+
+    def remove_media(media_id)
+      response = delete("/api/rest/media/#{media_id}",:body => {:appkey => @api_key, :action => "remove"})
+
+      case response.status
+      when 200
+      when 400
+        raise Telesocial::BadRequest.new("Missing or invalid parameter(s).", response)
+      when 401
+        raise Telesocial::Unauthorized.new("The content associated with the media ID cannot be removed.", response)
+      when 404
+        raise Telesocial::NotFound.new("The media ID is invalid.", response)
+      end
+
+      response
+    end
+
+    def create_conference(network_id, recording_id = nil, greeting_id = nil)
+
+      options = {}
+      options[:recordingid] = recording_id if recording_id
+      options[:greetingid]  = greeting_id if greeting_id
+
+      response = post("/api/rest/conference/", :body => {:networkid => args, :appkey => @api_key}.merge(options))
+
+      case response.status
+      when 201
+      when 502
+        raise Telesocial::BadGateway.new("The request cannot be fulfilled at this time.", response)
+      else
+        raise Telesocial::Error.new("The request cannot be fulfilled at this time.", response)
+      end
+
+      response
+
+    end
+
+    def add_to_conference(conference_id, network_id)
+      response = post("/api/rest/conference/#{conference_id}", :body => {:networkid => network_id, :appkey => @api_key, :action => 'add'})
+
+      case response.status
+      when 200
+      when 400
+        raise Telesocial::BadRequest.new("Missing or invalid parameter(s).", response)
+      when 502
+        raise Telesocial::BadGateway.new("Unable to initiate phone(s) call at this time.", response)
+      end
+
+      response
+
+    end
+
+    def close_conference(conference_id)
+      response = post("/api/rest/conference//#{conference_id}", :body => {:appkey => @api_key, :action => 'close'})
+
+      case response.status
+      when 200
+      when 400
+        raise Telesocial::BadRequest.new("Missing or invalid parameter(s).", response)
+      when 404
+        raise Telesocial::NotFound.new("The conference ID is invalid.", response)
+      when 502
+        raise Telesocial::BadGateway.new("Unable to terminate conference calls.", response)
+      end
+
+      response
+    end
+
+    def hangup_call(conference_id, network_id)
+      response = post("/api/rest/conference/#{conference_id}/#{network_id}", :body => {:appkey => @api_key, :action => 'hangup'})
+
+      case response.status
+      when 200
+      when 400
+        raise Telesocial::BadRequest.new("Missing or invalid parameter(s).", response)
+      when 401
+        raise Telesocial::Unauthorized.new("The specified network ID is not associated with the application identified by the application key.", response)
+      when 404
+        raise Telesocial::NotFound.new("The conference ID is invalid.", response)
+      when 502
+        raise Telesocial::BadGateway.new("Unable to terminate call at this time.", response)
+      end
+
+      response
+    end
+
+    def move_call(from_conference_id, to_conference_id, network_id)
+      response = post("/api/rest/conference/#{from_conference_id}/#{network_id}", :body => {:appkey => @api_key, :toconferenceid => to_conference_id, :action => 'move'})
+
+      case response.status
+      when 200
+      when 400
+        raise Telesocial::BadRequest.new("Missing or invalid parameter(s).", response)
+      when 401
+        raise Telesocial::Unauthorized.new("The specified network ID is not associated with the application identified by the application key.", response)
+      when 502
+        raise Telesocial::BadGateway.new("Unable to move call.", response)
+      end
+
+      response
+    end
+
+    def mute(conference_id, network_id)
+      response = post("/api/rest/conference/#{conference_id}/#{network_id}", :body => {:app_key => @api_key, :action => "mute"})
+
+      case response.status
+      when 200
+      when 400
+        raise Telesocial::BadRequest.new("Missing or invalid parameter(s).", response)
+      when 401
+        raise Telesocial::Unauthorized.new("One or more of the specified network IDs is not associated with the application identified by the application key.", response)
+      when 502
+        raise Telesocial::BadGateway.new("Unable to mute call(s).", response)
+      end
+
+      response
+    end
+
+    def unmute(conference_id, network_id)
+      response = self.class.post("/api/rest/conference/#{conference_id}/#{network_id}", :body => {:app_key => @api_key, :action => "unmute"})
+
+      case response.status
+      when 200
+      when 400
+        raise Telesocial::BadRequest.new("Missing or invalid parameter(s).", response)
+      when 401
+        raise Telesocial::Unauthorized.new("One or more of the specified network IDs is not associated with the application identified by the application key.", response)
+      when 502
+        raise Telesocial::BadGateway.new("Unable to unmute call(s).", response)
+      end
+
+      response
+    end
+
+    def get_version
+      response = self.class.get("/api/rest/version").parsed_response
+    end
+
+    def upload_file(upload_grant_id, file_path)
+      uri = URI.parse(self.class.base_uri)
+      req = Net::HTTP::Post::Multipart.new "/forklift/", {"grant" => upload_grant_id, "mediafile" => UploadIO.new(file_path, mime_for(file_path))}
+      http = Net::HTTP.new(uri.host, uri.port)
+      if (uri.scheme == "https")
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+      res = http.request(req)
+
+      case res
+      when Net::HTTPSuccess
+      when Net::HTTPBadRequest
+        raise Telesocial::BadRequest.new("Missing or invalid parameter(s).", res)
+      when Net::HTTPNotFound
+        raise Telesocial::NotFound.new("The grant code is invalid.", res)
+      when Net::HTTPRequestEntityTooLarge
+        raise Telesocial::RequestEntityTooLarge.new("The file is larger than the allowed limit.", res)
+      when Net::HTTPUnsupportedMediaType
+        raise Telesocial::UnsupportedMediaTpe.new("The file is not an MP3 file.  Only MP3 files may be uploaded at this time.", res)
+      end
+
+      res.body
+
+    end
+
+    # Handling for general errors
+    private
+    def post(url, options = {})
+      response = self.class.post(url, :query => options[:query], :body => options[:body])
+      parsed_response = response.parsed_response
+
+      case response.code
+      when 500
+        raise Telesocial::Error.new("Internal Server Error", response)
+      end
+
+      parsed_response
+    end
+
+     def get(url, options = {})
+      response = self.class.get(url, :query => options[:query])
+      parsed_response = response.parsed_response
+
+      case response.code
+      when 500
+        raise Telesocial::Error.new("Internal Server Error", response)
+      end
+
+      parsed_response
+    end
+
+    def delete(url, options = {})
+      response = self.class.delete(url, :query => options[:query], :body => options[:body])
+      parsed_response = response.parsed_response
+
+      case response.code
+      when 500
+        raise Telesocial::Error.new("Internal Server Error", response)
+      end
+
+      parsed_response
+    end
+
+    def mime_for(path)
+      mime = MIME::Types.type_for path
+      mime.empty? ? 'text/plain' : mime[0].content_type
+    end
+
+  end
+end
+

data/lib/telesocial/errors.rb

@@ -0,0 +1,23 @@
+module Telesocial
+  class Error < StandardError
+    attr_reader :response
+
+    def initialize(message, response)
+      @response = response
+      super(info(message, response))
+    end
+
+    def info(text = '', env = Hashie::Mash.new)
+      "#{text} - (server message: #{env.message})"
+    end
+  end
+
+  class NotFound < Error; end;
+  class Unauthorized < Error; end;
+  class BadRequest < Error; end;
+  class BadGateway < Error; end;
+  class RequestEntityTooLarge < Error; end;
+  class UnsupportedMediaTpe < Error; end;
+
+end
+

data/lib/telesocial/version.rb

@@ -0,0 +1,3 @@
+module Telesocial
+  VERSION = "0.0.2"
+end

data/lib/telesocial.rb

@@ -0,0 +1,5 @@
+require 'telesocial/version'
+require 'telesocial/client'
+require 'telesocial/errors'
+
+module Telesocial;end

data/telesocial.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "telesocial/version"
+
+Gem::Specification.new do |s|
+  s.name        = "telesocial"
+  s.version     = Telesocial::VERSION
+  s.authors     = ["Selem Delul"]
+  s.email       = ["selem@selem.im"]
+  s.homepage    = ""
+  s.summary     = %q{Ruby wrapper for Telesocial API}
+  s.description = %q{Ruby wrapper for Telesocial API}
+
+  s.rubyforge_project = "telesocial"
+
+  s.add_development_dependency "fakeweb"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "redgreen"
+  s.add_development_dependency "rocco"
+  s.add_development_dependency "rr"
+
+  s.add_dependency "httparty"
+  s.add_dependency "hashie"
+  s.add_dependency "multipart-post"
+  s.add_dependency "mime-types"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/test/telesocial_client_functional_test.rb

@@ -0,0 +1,38 @@
+require File.expand_path(File.dirname(__FILE__) + '/test_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../lib/telesocial')
+
+class TelesocialClientTest < Test::Unit::TestCase
+
+  def setup
+    @client = Telesocial::Client.new("f180804f-5eda-4e6b-8f4e-ecea52362396")
+  end
+
+  def test_check_existing_network_id
+    resp =  @client.get_registration_status("necrodome")
+    assert 200 == resp.status
+    assert resp.registered?
+  end
+
+  def test_check_non_existing_network_id
+    assert_raise(Telesocial::NotFound) { @client.get_registration_status("erica_and_some_other_chars")}
+  end
+
+  # This test needs to improved due to the fact that
+  # registration requires phone call.
+  # def test_succesful_registration
+  #  resp = @client.register("xxx", 1234567)
+  #  assert 201, resp.status
+  # end
+
+  def test_create_media
+    resp = @client.create_media()
+    assert 201 == resp.status
+    assert resp.uri?
+  end
+
+  def test_request_upload_grant
+    resp = @client.request_upload_grant("123c5e5b40c54eb198d69d64e37ed182")
+    assert 201 == resp.status
+  end
+
+end

data/test/telesocial_client_test.rb

@@ -0,0 +1,83 @@
+require File.expand_path(File.dirname(__FILE__) + '/test_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../lib/telesocial')
+
+class TelesocialClientTest < Test::Unit::TestCase
+
+  def test_check_existing_network_id
+    resp =  @client.get_registration_status("eric")
+    assert 200 == resp.status
+    assert resp.registered?
+  end
+
+  def test_check_non_existing_network_id
+    assert_raise(Telesocial::NotFound) { @client.get_registration_status("erica")}
+  end
+
+  def test_succesful_registration
+    resp = @client.register("xxx", 1234567)
+    assert 201 == resp.status
+  end
+
+  def test_create_media
+    resp = @client.create_media()
+    assert 201 == resp.status
+    assert resp.uri?
+  end
+
+  def test_request_upload_grant
+    resp = @client.request_upload_grant("123c5e5b40c54eb198d69d64e37ed182")
+    assert 201 == resp.status
+    assert resp.grantId == 5062406589092978092
+    assert resp.uri == "/api/rest/media/123c5e5b40c54eb198d69d64e37ed182/5062406589092978092"
+  end
+
+  def setup
+    @client = Telesocial::Client.new("key")
+
+    FakeWeb.allow_net_connect = false
+    FakeWeb.register_uri(
+      :post, "https://api4.bitmouth.com/api/rest/registrant/eric",
+      :content_type => "application/json; charset=utf-8",
+      :body => <<-JSON
+        {"RegistrantResponse":{"message":"","status":200}}
+      JSON
+      )
+
+    FakeWeb.register_uri(
+      :post, "https://api4.bitmouth.com/api/rest/registrant/erica",
+      :content_type => "application/json; charset=utf-8",
+      :body => <<-JSON
+        {"RegistrantResponse":{"message":"","status":404}}
+      JSON
+      )
+
+    FakeWeb.register_uri(
+      :post, "https://api4.bitmouth.com/api/rest/registrant/",
+      :data => {:name => "sdsd"},
+      :content_type => "application/json; charset=utf-8",
+      :body => <<-JSON
+        {"RegistrationResponse":{"message":"","status":201,"uri":"\/api\/rest\/registrant\/1000022816599"}}
+      JSON
+      )
+
+    FakeWeb.register_uri(
+      :post, "https://api4.bitmouth.com/api/rest/media/",
+      :content_type => "application/json; charset=utf-8",
+      :body => <<-JSON
+        {"MediaResponse":{"message":"","status":201,"downloadUrl":"","fileSize":0,"mediaId":"6e6a151be31b467f87225b18b0f36f00","uri":"\/api\/rest\/media\/6e6a151be31b467f87225b18b0f36f00"}}
+      JSON
+      )
+
+    FakeWeb.register_uri(
+      :post, "https://api4.bitmouth.com/api/rest/media/123c5e5b40c54eb198d69d64e37ed182",
+      :content_type => "application/json; charset=utf-8",
+      :body => <<-JSON
+        {"UploadResponse":{"message":"","status":201,"grantId":5062406589092978092,"uri":"\/api\/rest\/media\/123c5e5b40c54eb198d69d64e37ed182\/5062406589092978092"}}
+      JSON
+      )
+
+
+
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,14 @@
+require 'test/unit'
+require 'fakeweb'
+require 'rr'
+
+begin
+  require 'redgreen'
+rescue LoadError
+end
+
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+
+class Test::Unit::TestCase
+   include RR::Adapters::TestUnit
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: telesocial
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Selem Delul
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-06 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: &2151808920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2151808920
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2151807760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2151807760
+- !ruby/object:Gem::Dependency
+  name: redgreen
+  requirement: &2151806000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2151806000
+- !ruby/object:Gem::Dependency
+  name: rocco
+  requirement: &2151804620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2151804620
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: &2151801600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2151801600
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &2151797000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2151797000
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: &2151843080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2151843080
+- !ruby/object:Gem::Dependency
+  name: multipart-post
+  requirement: &2151846180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2151846180
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: &2151853180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2151853180
+description: Ruby wrapper for Telesocial API
+email:
+- selem@selem.im
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.markdown
+- Rakefile
+- lib/telesocial.rb
+- lib/telesocial/client.rb
+- lib/telesocial/errors.rb
+- lib/telesocial/version.rb
+- telesocial.gemspec
+- test/telesocial_client_functional_test.rb
+- test/telesocial_client_test.rb
+- test/test_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1926186920278007827
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1926186920278007827
+requirements: []
+rubyforge_project: telesocial
+rubygems_version: 1.8.7
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper for Telesocial API
+test_files:
+- test/telesocial_client_functional_test.rb
+- test/telesocial_client_test.rb
+- test/test_helper.rb