ringcentral 0.1.0 → 0.2.0

data/README.md

@@ -1,7 +1,7 @@
 [ringcentral](http://github.com/tfe/ringcentral/)
 ========
 
-A Ruby library for interacting with the RingCentral [RingOut API](https://service.ringcentral.com/ringoutapi/) and (coming soon) [FaxOut API](https://service.ringcentral.com/faxoutapi/).
+A Ruby library for interacting with the RingCentral [RingOut API](https://service.ringcentral.com/ringoutapi/) and [FaxOut API](https://service.ringcentral.com/faxoutapi/).
 
 Currently it is a very thin wrapper around the native RingCentral HTTP API. Eventually I would like to document and abstract away as many of the idiosyncrasies of the native API as possible.
 
@@ -152,17 +152,41 @@ The response is simply the session ID in a hash. The same response is given no m
 
 ### FaxOut
 
-To be implemented.
+There is only one method for faxing: `send`.
+
+    RingCentral::Fax.send(username, password, extension, recipient, attachment, cover_page = 'None', cover_page_text = nil, resolution = nil, send_time = nil)
+
+Send a fax to a given recipient with a given attachment (`File` object) using a given cover page (default is to not use a cover page). If the cover page option is set to nil, the default cover page will be used. Other cover page options exist, but RingCentral does not specify how to use them (you could experiment by putting different names in this parameter).
+
+You can also specify text to include on the cover page, the resolution to use (possible values are `Low` and `High`), and the time to send (GMT time in the format `dd:mm:yy hh:mm`). If send time is invalid or not in the future, the fax will be sent immediately.
+
+Credentials work the same as with the phone methods, with the exception that you can pass `nil` as the extension number, in which case the master account is used.
+
+The response is a simple status string. Possible values are as follows:
+
+* Successful
+* Authorization failed
+* Faxing is prohibited for the account
+* No recipients specified
+* No fax data specified
+* Generic error
+
+Note that this only indicates the status of the request to send the fax; it does not tell you anything about whether the fax was transmitted successfully or not. There is no way to check programmatically for the status of a fax. However, you will get an email with the results of the fax job at the address corresponding to the credentials/account you used to send the fax.
+
+    >> RingCentral::Fax.send('5556090455', 'qwerty', '100', '5556465589', File.new('/path/to/file.pdf'))
+    => "Successful"
+
 
 
 Todo
 ----
 
 * Be able to supply RingCentral account credentials once, up-front, rather than supplying with each API call.
-* Wrap up the call, status, and cancel into a Call object which maintains its state.
+* Wrap up the Phone call, status, and cancel methods into a Call object which maintains its state.
 * Set Call command arguments using response from the List command, perhaps so a user could do `call(:from => :mobile)`
 * Determine how accepting the RingCentral APIs are of formatted or malformed input.
-* Implement the FaxOut API.
+* Accept more than one recipient for faxing; allow more than one attachment.
+* Allow fax send method to take a real ruby `Time` object for the send time.
 * Write tests.
 
 

data/Rakefile

@@ -5,12 +5,13 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "ringcentral"
-    gem.summary = %Q{A Ruby library for interacting with the RingCentral RingOut API and (coming soon) FaxOut API.}
-    gem.description = %Q{A Ruby library for interacting with the RingCentral RingOut API and (coming soon) FaxOut API.}
+    gem.summary = "A Ruby library for interacting with the RingCentral RingOut API and FaxOut API."
+    gem.description = "A Ruby library for interacting with the RingCentral RingOut API and FaxOut API."
     gem.email = "todd@toddeichel.com"
     gem.homepage = "http://github.com/tfe/ringcentral"
     gem.authors = ["Todd Eichel"]
     gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    gem.add_dependency "rest-client", ">= 1.6.0"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/ringcentral.rb

@@ -9,6 +9,35 @@ module RingCentral
     PATH = 'faxapi.asp'
     URL = [RingCentral::URL, PATH].join('/')
     
+    STATUS_CODES = {
+      0 => 'Successful',
+      1 => 'Authorization failed',
+      2 => 'Faxing is prohibited for the account',
+      3 => 'No recipients specified',
+      4 => 'No fax data specified',
+      5 => 'Generic error'
+    }
+    
+    def self.send(username, password, extension, recipient, attachment, cover_page = 'None', cover_page_text = nil, resolution = nil, send_time = nil)
+      
+      params = {
+        :attachment => attachment,
+        :recipient => recipient,
+        :coverpage => cover_page,
+        :coverpagetext => cover_page_text,
+        :resolution => resolution,
+        :sendtime => send_time
+      }
+      
+      username_with_extension = [username, extension].compact.join('*')
+      
+      response = RestClient.post(URL, params.merge(RingCentral.credentials_hash(username_with_extension, password)))
+      
+      status_code = String.new(response.body).to_i # RestClient::Response casting to int behaves strangely
+      
+      return STATUS_CODES[status_code]
+    end
+    
   end
   
   class Phone

data/ringcentral.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ringcentral}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Todd Eichel"]
-  s.date = %q{2010-07-31}
-  s.description = %q{A Ruby library for interacting with the RingCentral RingOut API and (coming soon) FaxOut API.}
+  s.date = %q{2010-08-12}
+  s.description = %q{A Ruby library for interacting with the RingCentral RingOut API and FaxOut API.}
   s.email = %q{todd@toddeichel.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -33,7 +33,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.6}
-  s.summary = %q{A Ruby library for interacting with the RingCentral RingOut API and (coming soon) FaxOut API.}
+  s.summary = %q{A Ruby library for interacting with the RingCentral RingOut API and FaxOut API.}
   s.test_files = [
     "test/helper.rb",
      "test/test_ringcentral.rb"
@@ -45,11 +45,14 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_runtime_dependency(%q<rest-client>, [">= 1.6.0"])
     else
       s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<rest-client>, [">= 1.6.0"])
     end
   else
     s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<rest-client>, [">= 1.6.0"])
   end
 end
 

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Todd Eichel
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-31 00:00:00 -04:00
+date: 2010-08-12 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -29,7 +29,21 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id001
-description: A Ruby library for interacting with the RingCentral RingOut API and (coming soon) FaxOut API.
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 6
+        - 0
+        version: 1.6.0
+  type: :runtime
+  version_requirements: *id002
+description: A Ruby library for interacting with the RingCentral RingOut API and FaxOut API.
 email: todd@toddeichel.com
 executables: []
 
@@ -79,7 +93,7 @@ rubyforge_project:
 rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: A Ruby library for interacting with the RingCentral RingOut API and (coming soon) FaxOut API.
+summary: A Ruby library for interacting with the RingCentral RingOut API and FaxOut API.
 test_files: 
 - test/helper.rb
 - test/test_ringcentral.rb